{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Hyperline","colors":{"primary":"#1A1A1A","light":"#999999","dark":"#1A1A1A"},"logo":{"light":"https://mintcdn.com/hyperline/G-7ZQgHUOVHWwtUN/layout/logo-dark.png?fit=max\u0026auto=format\u0026n=G-7ZQgHUOVHWwtUN\u0026q=85\u0026s=2521f5f5ce4977d387d12aa169a8ee55","dark":"https://mintcdn.com/hyperline/G-7ZQgHUOVHWwtUN/layout/logo-light.png?fit=max\u0026auto=format\u0026n=G-7ZQgHUOVHWwtUN\u0026q=85\u0026s=c81125a44e9fdf8006623ab1f597ce7f"},"favicon":"https://mintcdn.com/hyperline/xZrQhb6Rphak0y92/favicon.png?fit=max\u0026auto=format\u0026n=xZrQhb6Rphak0y92\u0026q=85\u0026s=c52ed2ba655f301d3a99a7987888c622","api":{"openapi":["https://api.hyperline.co/openapi","https://ingest.hyperline.co/openapi"],"playground":{"display":"interactive"},"mdx":{"auth":{"method":"bearer"},"server":["https://api.hyperline.co","https://ingest.hyperline.co"]}},"appearance":{"default":"light"},"background":{"color":{"light":"#fafafa","dark":"#1f1f1f"}},"navbar":{"links":[{"href":"https://www.hyperline.co/talk-to-sales","label":"Book a call"}],"primary":{"type":"button","label":"Get Started","href":"https://app.hyperline.co"}},"footer":{"links":[{"header":"Resources","items":[{"label":"Status","href":"https://status.hyperline.co"},{"label":"Changelog","href":"https://docs.hyperline.co/changelog"},{"label":"Glossary","href":"https://docs.hyperline.co/docs/introduction/glossary"},{"label":"Contact support","href":"mailto:support@hyperline.co"}]},{"header":"Company","items":[{"label":"Customers","href":"https://www.hyperline.co/resources/customers"},{"label":"Blog","href":"https://www.hyperline.co/resources/blog"},{"label":"Careers","href":"https://www.welcometothejungle.com/fr/companies/hyperline"},{"label":"Media Kit","href":"https://drive.google.com/drive/folders/1KIlufVDz6tgwohTFFv1jSyoqeHO0pKOm"}]},{"header":"Legal","items":[{"label":"Privacy Policy","href":"https://www.hyperline.co/privacy-policy"},{"label":"Terms of Service","href":"https://www.hyperline.co/terms-of-service"},{"label":"Security","href":"https://docs.hyperline.co/security"}]}]},"seo":{"metatags":{"og:image":"https://app.hyperline.co/auth/background.svg"},"indexing":"navigable"},"fonts":{"family":"Inter"},"integrations":{"posthog":{"apiKey":"phc_KmmpIQ7SFNwnur6ZqVC118l5EkS1pqo313t4qxwL32n","apiHost":"https://eu.posthog.com"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"hyperline","hasAudioNarration":false,"actualSubdomain":"hyperline","customDomains":["docs.hyperline.co"],"gitSource":{"type":"github","owner":"meterly","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"DISABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b009f76c04444b249e03fe8","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Developers","count":400},{"language":"default","tag":"API reference","count":385},{"language":"default","tag":"Documentation","count":113},{"language":"default","tag":"Accounting","count":79},{"language":"default","tag":"Customers","count":58},{"language":"default","tag":"Subscriptions","count":55},{"language":"default","tag":"Catalog","count":52},{"language":"default","tag":"Integrations","count":43},{"language":"default","tag":"Agents","count":39},{"language":"default","tag":"Billing","count":36}]},"assistantConfig":{"enableStarterQuestions":false,"deflection":{"enabled":true,"email":"support@hyperline.co","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"index.css","content":"a[href*=\"mintlify.com\"]{display:none;visibility:hidden}.text-2xl{font-weight:600}.tag-blue{height:20px;line-height:20px;display:inline-block;background:#93c5fd;margin:0;padding:0 6px;border-radius:4px;color:#0166ff;border:1px solid #0166ff;font-weight:600;font-size:12px}.tag-orange{height:20px;line-height:20px;display:inline-block;background:#fef9e0;margin:0;padding:0 6px;border-radius:4px;color:#da9e09;border:1px solid #da9e09;font-weight:600;font-size:12px}#footer>div>div:not(:first-child){display:none;visibility:hidden}"},{"filePath":"developers/getting-started.css","content":"#content-area:has(#developer-home){max-width:56rem;margin-inline:auto}"},{"filePath":"developers/api-navigation.css","content":"#sidebar-content button .nav-tag-pill-text{color:#737373;background-color:rgb(0 0 0 / 4%);font-weight:400;font-variant-numeric:tabular-nums}.dark #sidebar-content button .nav-tag-pill-text{color:#a3a3a3;background-color:rgb(255 255 255 / 6%)}#sidebar-content button svg[style*=\"arrow-turn-down-right.svg\"]{width:0.75rem;height:0.75rem;mask-size:contain;opacity:0.65;flex-shrink:0}"}]}
{"page":{"pagePath":"api-reference/endpoints/ai->-billing/get-billing-balance","slug":"/api-reference/endpoints/ai->-billing/get-billing-balance","pageMetadata":{"openapi":"get /v1/ai/billing/customers/{id}/balance","title":"Get billing balance","description":"Get the live shared-pool balance and agent scopes, or the effective balance for agent_slug with fallback to the shared pool.","href":"/api-reference/endpoints/ai->-billing/get-billing-balance"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Get the live shared-pool balance and agent scopes, or the effective balance for agent_slug with fallback to the shared pool.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"get /v1/ai/billing/customers/{id}/balance","title":"Get billing balance","description":"Get the live shared-pool balance and agent scopes, or the effective balance for agent_slug with fallback to the shared pool.","href":"/api-reference/endpoints/ai->-billing/get-billing-balance"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getAgentCustomerBalance","tags":["AI > Billing"],"security":["469fe341-ffee-4f28-b415-3dc7c73afcc9"],"summary":"Get billing balance","description":"Get the live shared-pool balance and agent scopes, or the effective balance for agent_slug with fallback to the shared pool.","parameters":["89888ebf-460f-40a4-8f59-643b822c2a57","767773f3-8fc6-4ef3-8f5e-276f75dbeeb6"],"responses":{"200":"097126bb-9326-4d93-ad98-52fa5ab8b318","400":"d8032b14-bfc0-4971-956f-3165cb58962c","404":"fc2b0afb-f526-446e-9402-e7bea0eef263","409":"e0c58e6e-17de-40ab-847a-1efa654f4d7a"},"method":"get","type":"path","servers":["558fe1ad-2436-4db0-9a94-8a05e02f1824","8e84696b-4799-41b0-a022-0969d81ba65a"],"path":"/v1/ai/billing/customers/{id}/balance","baseUrlOptions":["https://api.hyperline.co","https://sandbox.api.hyperline.co"],"title":"Get billing balance","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"89888ebf-460f-40a4-8f59-643b822c2a57":{"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"name":"id","in":"path"},"767773f3-8fc6-4ef3-8f5e-276f75dbeeb6":{"schema":{"type":"string","minLength":1,"maxLength":128,"description":"Agent scope identifier. Null is the customer's shared pool.","example":"support","isRequired":false,"uniqueKey":"","typeLabel":"string"},"required":false,"description":"Agent scope identifier. Null is the customer's shared pool.","name":"agent_slug","in":"query"}},"responses":{"097126bb-9326-4d93-ad98-52fa5ab8b318":{"description":"","content":{"application/json":{"schema":{"type":"object","properties":{"agent_slug":{"oneOf":[{"type":"string","description":"Agent scope identifier. Null is the customer's shared pool.","example":"support","isRequired":true,"uniqueKey":"agent_slug.oneOf.0","typeLabel":"string"},{"type":"null","description":"Agent scope identifier. Null is the customer's shared pool.","example":"support","isRequired":true,"uniqueKey":"agent_slug.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"agent_slug","typeLabel":"string | null"},"mode":{"oneOf":[{"type":"string","enum":["wallet","credits","windows"],"description":"Billing mode.\n\n- wallet: Charges a monetary wallet.\n- credits: Consumes a credit balance.\n- windows: Meters weighted units against rolling allowances.","example":"wallet","isRequired":true,"uniqueKey":"mode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["wallet","credits","windows"],"description":"Billing mode.\n\n- wallet: Charges a monetary wallet.\n- credits: Consumes a credit balance.\n- windows: Meters weighted units against rolling allowances.","example":"wallet","isRequired":true,"uniqueKey":"mode.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"mode","typeLabel":"enum\u003cstring> | null"},"balance":{"type":"object","properties":{"currency":{"oneOf":[{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"ISO 4217 currency code for monetary values. Null for counts or historical amounts without recorded currency.","example":"USD","isRequired":true,"uniqueKey":"balance.currency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"ISO 4217 currency code for monetary values. Null for counts or historical amounts without recorded currency.","example":"USD","isRequired":true,"uniqueKey":"balance.currency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"balance.currency","typeLabel":"enum\u003cstring> | null"},"denomination":{"type":"string","enum":["minor_units","credits","units"],"description":"Unit of account for amounts.\n\n- minor_units: Fractional minor units of the accompanying currency.\n- credits: Credit counts, without a currency.\n- units: Weighted rolling-allowance units, without a currency.","example":"minor_units","isRequired":true,"uniqueKey":"balance.denomination","typeLabel":"enum\u003cstring>"},"wallet":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Settled wallet balance, credit balance, or included allowance, in the accompanying denomination.","example":"10000","isRequired":true,"uniqueKey":"balance.wallet","typeLabel":"string"},"unsettled":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Unsettled monetary consumption or used allowance units, in the accompanying denomination.","example":"12.5","isRequired":true,"uniqueKey":"balance.unsettled","typeLabel":"string"},"available":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Available amount in the accompanying denomination. May be negative for a wallet.","example":"9987.5","isRequired":true,"uniqueKey":"balance.available","typeLabel":"string"}},"required":["currency","denomination","wallet","unsettled","available"],"description":"Current balance in the accompanying denomination.","example":{"currency":"USD","denomination":"minor_units","wallet":"10000","unsettled":"12.5","available":"9987.5"},"isRequired":true,"uniqueKey":"balance","typeLabel":"object"},"blocked":{"type":"boolean","description":"Whether spending is disabled for this billing scope.","example":false,"isRequired":true,"uniqueKey":"blocked","typeLabel":"boolean"},"policy":{"oneOf":[{"type":"object","properties":{"markup_percent":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Percentage added to resolved cost. Null on writes means no override; an attached plan may supply the value.","example":"20","isRequired":true,"uniqueKey":"policy.oneOf.0.markup_percent","typeLabel":"string"},"floor":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Minimum available balance a spend check requires, in the policy's denomination.","example":"0","isRequired":true,"uniqueKey":"policy.oneOf.0.floor","typeLabel":"string"},"settlement_interval_minutes":{"oneOf":[{"type":"number","description":"Settlement interval in minutes. Null means no interval override. Mutually exclusive with settlement_schedule.","example":60,"isRequired":true,"uniqueKey":"policy.oneOf.0.settlement_interval_minutes.oneOf.0","typeLabel":"number"},{"type":"null","description":"Settlement interval in minutes. Null means no interval override. Mutually exclusive with settlement_schedule.","example":60,"isRequired":true,"uniqueKey":"policy.oneOf.0.settlement_interval_minutes.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"policy.oneOf.0.settlement_interval_minutes","typeLabel":"number | null"}},"required":["markup_percent","floor","settlement_interval_minutes"],"description":"Billing rules resolved for this scope, or null when unconfigured.","example":null,"isRequired":true,"uniqueKey":"policy.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"markup_percent":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Percentage added to resolved cost. Null on writes means no override; an attached plan may supply the value.","example":"20"},"floor":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Minimum available balance a spend check requires, in the policy's denomination.","example":"0"},"settlement_interval_minutes":{"oneOf":[{"type":"number","description":"Settlement interval in minutes. Null means no interval override. Mutually exclusive with settlement_schedule.","example":60},{"type":"null","description":"Settlement interval in minutes. Null means no interval override. Mutually exclusive with settlement_schedule.","example":60}]}},"required":["markup_percent","floor","settlement_interval_minutes"],"description":"Billing rules resolved for this scope, or null when unconfigured.","example":null,"isRequired":true,"uniqueKey":"policy.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"policy","typeLabel":"object | null"},"meters":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Dimension or allowance identifier used by usage payloads and meter results.","example":"cached_input_tokens","isRequired":true,"uniqueKey":"meters.oneOf.0.items.[INDEX].key","typeLabel":"string"},"included_units":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Weighted units included in one allowance window, as an exact decimal string.","example":"10000","isRequired":true,"uniqueKey":"meters.oneOf.0.items.[INDEX].included_units","typeLabel":"string"},"used_units":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Allowance units already consumed in the current window.","example":"2500","isRequired":true,"uniqueKey":"meters.oneOf.0.items.[INDEX].used_units","typeLabel":"string"},"remaining_units":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Unconsumed allowance units, clamped at zero.","example":"7500","isRequired":true,"uniqueKey":"meters.oneOf.0.items.[INDEX].remaining_units","typeLabel":"string"},"window_started_at":{"oneOf":[{"type":"string","format":"date-time","description":"Window started at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-02T00:00:00Z","isRequired":true,"uniqueKey":"meters.oneOf.0.items.[INDEX].window_started_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Window started at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-02T00:00:00Z","isRequired":true,"uniqueKey":"meters.oneOf.0.items.[INDEX].window_started_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meters.oneOf.0.items.[INDEX].window_started_at","typeLabel":"string\u003cdate-time> | null"},"resets_at":{"oneOf":[{"type":"string","format":"date-time","description":"Resets at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-03T00:00:00Z","isRequired":true,"uniqueKey":"meters.oneOf.0.items.[INDEX].resets_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Resets at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-03T00:00:00Z","isRequired":true,"uniqueKey":"meters.oneOf.0.items.[INDEX].resets_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meters.oneOf.0.items.[INDEX].resets_at","typeLabel":"string\u003cdate-time> | null"}},"required":["key","included_units","used_units","remaining_units","window_started_at","resets_at"],"uniqueKey":"meters.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Current state of every rolling allowance window, or null outside windows mode.","example":[{"key":"daily","included_units":"10000","used_units":"2500","remaining_units":"7500","window_started_at":"2026-09-02T00:00:00Z","resets_at":"2026-09-03T00:00:00Z"}],"isRequired":true,"uniqueKey":"meters.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"key":{"type":"string","description":"Dimension or allowance identifier used by usage payloads and meter results.","example":"cached_input_tokens"},"included_units":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Weighted units included in one allowance window, as an exact decimal string.","example":"10000"},"used_units":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Allowance units already consumed in the current window.","example":"2500"},"remaining_units":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Unconsumed allowance units, clamped at zero.","example":"7500"},"window_started_at":{"oneOf":[{"type":"string","format":"date-time","description":"Window started at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-02T00:00:00Z"},{"type":"null","format":"date-time","description":"Window started at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-02T00:00:00Z"}]},"resets_at":{"oneOf":[{"type":"string","format":"date-time","description":"Resets at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-03T00:00:00Z"},{"type":"null","format":"date-time","description":"Resets at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-03T00:00:00Z"}]}},"required":["key","included_units","used_units","remaining_units","window_started_at","resets_at"]},"description":"Current state of every rolling allowance window, or null outside windows mode.","example":[{"key":"daily","included_units":"10000","used_units":"2500","remaining_units":"7500","window_started_at":"2026-09-02T00:00:00Z","resets_at":"2026-09-03T00:00:00Z"}],"isRequired":true,"uniqueKey":"meters.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"meters","typeLabel":"object[] | null"},"credits":{"oneOf":[{"type":"object","properties":{"balance":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Current balance in the accompanying denomination.","example":"10000","isRequired":true,"uniqueKey":"credits.oneOf.0.balance","typeLabel":"string"},"currency":{"type":"null","description":"ISO 4217 currency code for monetary values. Null for counts or historical amounts without recorded currency.","example":null,"isRequired":true,"uniqueKey":"credits.oneOf.0.currency","typeLabel":"null"},"product_id":{"type":"string","description":"ID of the credit product the balance or rate card belongs to.","example":"prd_credits","isRequired":true,"uniqueKey":"credits.oneOf.0.product_id","typeLabel":"string"},"low_balance_threshold":{"oneOf":[{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Credit balance threshold for low-balance alerts, or null when unset.","example":"1000","isRequired":true,"uniqueKey":"credits.oneOf.0.low_balance_threshold.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Credit balance threshold for low-balance alerts, or null when unset.","example":"1000","isRequired":true,"uniqueKey":"credits.oneOf.0.low_balance_threshold.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credits.oneOf.0.low_balance_threshold","typeLabel":"string | null"},"expiring_soon":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Exact amount in the accompanying denomination; monetary ledger amounts are fractional minor units.","example":"12.5","isRequired":true,"uniqueKey":"credits.oneOf.0.expiring_soon.items.[INDEX].amount","typeLabel":"string"},"expires_at":{"type":"string","format":"date-time","description":"Credit expiry instant in UTC ISO 8601 format.","example":"2026-10-01T00:00:00Z","isRequired":true,"uniqueKey":"credits.oneOf.0.expiring_soon.items.[INDEX].expires_at","typeLabel":"string\u003cdate-time>"}},"required":["amount","expires_at"],"uniqueKey":"credits.oneOf.0.expiring_soon.items.[INDEX]","typeLabel":"object"},"description":"Credit grants expiring within 30 days. Amounts are original grants, not remaining balances.","example":[{"amount":"10000","expires_at":"2026-10-01T00:00:00Z"}],"isRequired":true,"uniqueKey":"credits.oneOf.0.expiring_soon","typeLabel":"object[]"},"rate_card_summary":{"type":"object","properties":{"llm_rows":{"type":"number","description":"Number of LLM pricing rows.","example":1,"isRequired":true,"uniqueKey":"credits.oneOf.0.rate_card_summary.llm_rows","typeLabel":"number"},"item_rows":{"type":"number","description":"Number of item rows.","example":0,"isRequired":true,"uniqueKey":"credits.oneOf.0.rate_card_summary.item_rows","typeLabel":"number"},"has_default_llm_row":{"type":"boolean","description":"Whether a wildcard LLM row supplies rates for otherwise unmatched models.","example":true,"isRequired":true,"uniqueKey":"credits.oneOf.0.rate_card_summary.has_default_llm_row","typeLabel":"boolean"},"fallback_credits_per_usd":{"oneOf":[{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Credits charged per USD of unmatched provider cost. Omission leaves unmatched usage unpriced.","example":"1000","isRequired":true,"uniqueKey":"credits.oneOf.0.rate_card_summary.fallback_credits_per_usd.oneOf.0","typeLabel":"string"},{"type":"null","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Credits charged per USD of unmatched provider cost. Omission leaves unmatched usage unpriced.","example":"1000","isRequired":true,"uniqueKey":"credits.oneOf.0.rate_card_summary.fallback_credits_per_usd.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credits.oneOf.0.rate_card_summary.fallback_credits_per_usd","typeLabel":"string | null"}},"required":["llm_rows","item_rows","has_default_llm_row","fallback_credits_per_usd"],"description":"Summary of the pricing available to this credit balance.","example":{"llm_rows":1,"item_rows":0,"has_default_llm_row":true,"fallback_credits_per_usd":"1000"},"isRequired":true,"uniqueKey":"credits.oneOf.0.rate_card_summary","typeLabel":"object"}},"required":["balance","currency","product_id","low_balance_threshold","expiring_soon","rate_card_summary"],"description":"Credit balance and product details, or null outside credits mode.","example":null,"isRequired":true,"uniqueKey":"credits.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"balance":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Current balance in the accompanying denomination.","example":"10000"},"currency":{"type":"null","description":"ISO 4217 currency code for monetary values. Null for counts or historical amounts without recorded currency.","example":null},"product_id":{"type":"string","description":"ID of the credit product the balance or rate card belongs to.","example":"prd_credits"},"low_balance_threshold":{"oneOf":[{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Credit balance threshold for low-balance alerts, or null when unset.","example":"1000"},{"type":"null","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Credit balance threshold for low-balance alerts, or null when unset.","example":"1000"}]},"expiring_soon":{"type":"array","items":{"type":"object","properties":{"amount":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Exact amount in the accompanying denomination; monetary ledger amounts are fractional minor units.","example":"12.5"},"expires_at":{"type":"string","format":"date-time","description":"Credit expiry instant in UTC ISO 8601 format.","example":"2026-10-01T00:00:00Z"}},"required":["amount","expires_at"]},"description":"Credit grants expiring within 30 days. Amounts are original grants, not remaining balances.","example":[{"amount":"10000","expires_at":"2026-10-01T00:00:00Z"}]},"rate_card_summary":{"type":"object","properties":{"llm_rows":{"type":"number","description":"Number of LLM pricing rows.","example":1},"item_rows":{"type":"number","description":"Number of item rows.","example":0},"has_default_llm_row":{"type":"boolean","description":"Whether a wildcard LLM row supplies rates for otherwise unmatched models.","example":true},"fallback_credits_per_usd":{"oneOf":[{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Credits charged per USD of unmatched provider cost. Omission leaves unmatched usage unpriced.","example":"1000"},{"type":"null","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Credits charged per USD of unmatched provider cost. Omission leaves unmatched usage unpriced.","example":"1000"}]}},"required":["llm_rows","item_rows","has_default_llm_row","fallback_credits_per_usd"],"description":"Summary of the pricing available to this credit balance.","example":{"llm_rows":1,"item_rows":0,"has_default_llm_row":true,"fallback_credits_per_usd":"1000"}}},"required":["balance","currency","product_id","low_balance_threshold","expiring_soon","rate_card_summary"],"description":"Credit balance and product details, or null outside credits mode.","example":null,"isRequired":true,"uniqueKey":"credits.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"credits","typeLabel":"object | null"},"overage":{"oneOf":[{"type":"object","properties":{"currency":{"oneOf":[{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"ISO 4217 currency code for monetary values. Null for counts or historical amounts without recorded currency.","example":"USD","isRequired":true,"uniqueKey":"overage.oneOf.0.currency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"ISO 4217 currency code for monetary values. Null for counts or historical amounts without recorded currency.","example":"USD","isRequired":true,"uniqueKey":"overage.oneOf.0.currency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"overage.oneOf.0.currency","typeLabel":"enum\u003cstring> | null"},"mode":{"type":"string","enum":["refuse","metered"],"description":"Behavior when credits or an allowance are exhausted. Policy values may inherit the attached plan.\n\n- refuse: Rejects the call that crosses the boundary without deducting usage.\n- metered: Prices the whole call as monetary overage, using the overage card or USD provider cost plus markup.","example":"metered","isRequired":true,"uniqueKey":"overage.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"active":{"type":"boolean","description":"Whether the scope has exhausted its included credits or allowance.","example":false,"isRequired":true,"uniqueKey":"overage.oneOf.0.active","typeLabel":"boolean"},"unsettled":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Unsettled monetary consumption or used allowance units, in the accompanying denomination.","example":"12.5","isRequired":true,"uniqueKey":"overage.oneOf.0.unsettled","typeLabel":"string"}},"required":["currency","mode","active","unsettled"],"description":"Overage policy, current boundary status and unsettled monetary balance; null in wallet mode.","example":{"currency":"USD","mode":"metered","active":false,"unsettled":"0"},"isRequired":true,"uniqueKey":"overage.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"currency":{"oneOf":[{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"ISO 4217 currency code for monetary values. Null for counts or historical amounts without recorded currency.","example":"USD"},{"type":"null","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"ISO 4217 currency code for monetary values. Null for counts or historical amounts without recorded currency.","example":"USD"}]},"mode":{"type":"string","enum":["refuse","metered"],"description":"Behavior when credits or an allowance are exhausted. Policy values may inherit the attached plan.\n\n- refuse: Rejects the call that crosses the boundary without deducting usage.\n- metered: Prices the whole call as monetary overage, using the overage card or USD provider cost plus markup.","example":"metered"},"active":{"type":"boolean","description":"Whether the scope has exhausted its included credits or allowance.","example":false},"unsettled":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Unsettled monetary consumption or used allowance units, in the accompanying denomination.","example":"12.5"}},"required":["currency","mode","active","unsettled"],"description":"Overage policy, current boundary status and unsettled monetary balance; null in wallet mode.","example":{"currency":"USD","mode":"metered","active":false,"unsettled":"0"},"isRequired":true,"uniqueKey":"overage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"overage","typeLabel":"object | null"},"last_settled_at":{"oneOf":[{"type":"string","format":"date-time","description":"Last settled at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-02T00:00:00Z","isRequired":true,"uniqueKey":"last_settled_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Last settled at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-02T00:00:00Z","isRequired":true,"uniqueKey":"last_settled_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"last_settled_at","typeLabel":"string\u003cdate-time> | null"},"agents":{"type":"array","items":{"type":"object","properties":{"agent_slug":{"oneOf":[{"type":"string","description":"Agent scope identifier. Null is the customer's shared pool.","example":"support","isRequired":true,"uniqueKey":"agents.items.[INDEX].agent_slug.oneOf.0","typeLabel":"string"},{"type":"null","description":"Agent scope identifier. Null is the customer's shared pool.","example":"support","isRequired":true,"uniqueKey":"agents.items.[INDEX].agent_slug.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"agents.items.[INDEX].agent_slug","typeLabel":"string | null"},"mode":{"type":"string","enum":["wallet","credits","windows"],"description":"Billing mode.\n\n- wallet: Charges a monetary wallet.\n- credits: Consumes a credit balance.\n- windows: Meters weighted units against rolling allowances.","example":"wallet","isRequired":true,"uniqueKey":"agents.items.[INDEX].mode","typeLabel":"enum\u003cstring>"},"balance":{"type":"object","properties":{"currency":{"oneOf":[{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"ISO 4217 currency code for monetary values. Null for counts or historical amounts without recorded currency.","example":"USD","isRequired":true,"uniqueKey":"agents.items.[INDEX].balance.currency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"ISO 4217 currency code for monetary values. Null for counts or historical amounts without recorded currency.","example":"USD","isRequired":true,"uniqueKey":"agents.items.[INDEX].balance.currency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"agents.items.[INDEX].balance.currency","typeLabel":"enum\u003cstring> | null"},"denomination":{"type":"string","enum":["minor_units","credits","units"],"description":"Unit of account for amounts.\n\n- minor_units: Fractional minor units of the accompanying currency.\n- credits: Credit counts, without a currency.\n- units: Weighted rolling-allowance units, without a currency.","example":"minor_units","isRequired":true,"uniqueKey":"agents.items.[INDEX].balance.denomination","typeLabel":"enum\u003cstring>"},"wallet":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Settled wallet balance, credit balance, or included allowance, in the accompanying denomination.","example":"10000","isRequired":true,"uniqueKey":"agents.items.[INDEX].balance.wallet","typeLabel":"string"},"unsettled":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Unsettled monetary consumption or used allowance units, in the accompanying denomination.","example":"12.5","isRequired":true,"uniqueKey":"agents.items.[INDEX].balance.unsettled","typeLabel":"string"},"available":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Available amount in the accompanying denomination. May be negative for a wallet.","example":"9987.5","isRequired":true,"uniqueKey":"agents.items.[INDEX].balance.available","typeLabel":"string"}},"required":["currency","denomination","wallet","unsettled","available"],"description":"Current balance in the accompanying denomination.","example":{"currency":"USD","denomination":"minor_units","wallet":"10000","unsettled":"12.5","available":"9987.5"},"isRequired":true,"uniqueKey":"agents.items.[INDEX].balance","typeLabel":"object"},"blocked":{"type":"boolean","description":"Whether spending is disabled for this billing scope.","example":false,"isRequired":true,"uniqueKey":"agents.items.[INDEX].blocked","typeLabel":"boolean"},"meters":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Dimension or allowance identifier used by usage payloads and meter results.","example":"cached_input_tokens","isRequired":true,"uniqueKey":"agents.items.[INDEX].meters.oneOf.0.items.[INDEX].key","typeLabel":"string"},"included_units":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Weighted units included in one allowance window, as an exact decimal string.","example":"10000","isRequired":true,"uniqueKey":"agents.items.[INDEX].meters.oneOf.0.items.[INDEX].included_units","typeLabel":"string"},"used_units":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Allowance units already consumed in the current window.","example":"2500","isRequired":true,"uniqueKey":"agents.items.[INDEX].meters.oneOf.0.items.[INDEX].used_units","typeLabel":"string"},"remaining_units":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Unconsumed allowance units, clamped at zero.","example":"7500","isRequired":true,"uniqueKey":"agents.items.[INDEX].meters.oneOf.0.items.[INDEX].remaining_units","typeLabel":"string"},"window_started_at":{"oneOf":[{"type":"string","format":"date-time","description":"Window started at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-02T00:00:00Z","isRequired":true,"uniqueKey":"agents.items.[INDEX].meters.oneOf.0.items.[INDEX].window_started_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Window started at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-02T00:00:00Z","isRequired":true,"uniqueKey":"agents.items.[INDEX].meters.oneOf.0.items.[INDEX].window_started_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"agents.items.[INDEX].meters.oneOf.0.items.[INDEX].window_started_at","typeLabel":"string\u003cdate-time> | null"},"resets_at":{"oneOf":[{"type":"string","format":"date-time","description":"Resets at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-03T00:00:00Z","isRequired":true,"uniqueKey":"agents.items.[INDEX].meters.oneOf.0.items.[INDEX].resets_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Resets at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-03T00:00:00Z","isRequired":true,"uniqueKey":"agents.items.[INDEX].meters.oneOf.0.items.[INDEX].resets_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"agents.items.[INDEX].meters.oneOf.0.items.[INDEX].resets_at","typeLabel":"string\u003cdate-time> | null"}},"required":["key","included_units","used_units","remaining_units","window_started_at","resets_at"],"uniqueKey":"agents.items.[INDEX].meters.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Current state of every rolling allowance window, or null outside windows mode.","example":[{"key":"daily","included_units":"10000","used_units":"2500","remaining_units":"7500","window_started_at":"2026-09-02T00:00:00Z","resets_at":"2026-09-03T00:00:00Z"}],"isRequired":true,"uniqueKey":"agents.items.[INDEX].meters.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"key":{"type":"string","description":"Dimension or allowance identifier used by usage payloads and meter results.","example":"cached_input_tokens"},"included_units":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Weighted units included in one allowance window, as an exact decimal string.","example":"10000"},"used_units":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Allowance units already consumed in the current window.","example":"2500"},"remaining_units":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Unconsumed allowance units, clamped at zero.","example":"7500"},"window_started_at":{"oneOf":[{"type":"string","format":"date-time","description":"Window started at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-02T00:00:00Z"},{"type":"null","format":"date-time","description":"Window started at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-02T00:00:00Z"}]},"resets_at":{"oneOf":[{"type":"string","format":"date-time","description":"Resets at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-03T00:00:00Z"},{"type":"null","format":"date-time","description":"Resets at, as a UTC ISO 8601 timestamp. Null when unavailable.","example":"2026-09-03T00:00:00Z"}]}},"required":["key","included_units","used_units","remaining_units","window_started_at","resets_at"]},"description":"Current state of every rolling allowance window, or null outside windows mode.","example":[{"key":"daily","included_units":"10000","used_units":"2500","remaining_units":"7500","window_started_at":"2026-09-02T00:00:00Z","resets_at":"2026-09-03T00:00:00Z"}],"isRequired":true,"uniqueKey":"agents.items.[INDEX].meters.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"agents.items.[INDEX].meters","typeLabel":"object[] | null"},"overage":{"oneOf":[{"type":"object","properties":{"currency":{"oneOf":[{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"ISO 4217 currency code for monetary values. Null for counts or historical amounts without recorded currency.","example":"USD","isRequired":true,"uniqueKey":"agents.items.[INDEX].overage.oneOf.0.currency.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"ISO 4217 currency code for monetary values. Null for counts or historical amounts without recorded currency.","example":"USD","isRequired":true,"uniqueKey":"agents.items.[INDEX].overage.oneOf.0.currency.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"agents.items.[INDEX].overage.oneOf.0.currency","typeLabel":"enum\u003cstring> | null"},"mode":{"type":"string","enum":["refuse","metered"],"description":"Behavior when credits or an allowance are exhausted. Policy values may inherit the attached plan.\n\n- refuse: Rejects the call that crosses the boundary without deducting usage.\n- metered: Prices the whole call as monetary overage, using the overage card or USD provider cost plus markup.","example":"metered","isRequired":true,"uniqueKey":"agents.items.[INDEX].overage.oneOf.0.mode","typeLabel":"enum\u003cstring>"},"active":{"type":"boolean","description":"Whether the scope has exhausted its included credits or allowance.","example":false,"isRequired":true,"uniqueKey":"agents.items.[INDEX].overage.oneOf.0.active","typeLabel":"boolean"},"unsettled":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Unsettled monetary consumption or used allowance units, in the accompanying denomination.","example":"12.5","isRequired":true,"uniqueKey":"agents.items.[INDEX].overage.oneOf.0.unsettled","typeLabel":"string"}},"required":["currency","mode","active","unsettled"],"description":"Overage policy, current boundary status and unsettled monetary balance; null in wallet mode.","example":{"currency":"USD","mode":"metered","active":false,"unsettled":"0"},"isRequired":true,"uniqueKey":"agents.items.[INDEX].overage.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"currency":{"oneOf":[{"type":"string","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"ISO 4217 currency code for monetary values. Null for counts or historical amounts without recorded currency.","example":"USD"},{"type":"null","enum":["EUR","AED","AFN","XCD","ALL","AMD","AOA","ARS","USD","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","XOF","BMD","BND","BOB","BRL","BSD","BTN","NOK","BWP","BYR","BZD","CAD","CDF","XAF","CHF","NZD","CLP","CNY","COP","CRC","CUP","CVE","ANG","CZK","DJF","DKK","DOP","DZD","EGP","MAD","ERN","ETB","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","XPF","NGN","NIO","NPR","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","UYU","UZS","VEF","VND","VUV","WST","YER","ZAR","ZMW","ZWL"],"description":"ISO 4217 currency code for monetary values. Null for counts or historical amounts without recorded currency.","example":"USD"}]},"mode":{"type":"string","enum":["refuse","metered"],"description":"Behavior when credits or an allowance are exhausted. Policy values may inherit the attached plan.\n\n- refuse: Rejects the call that crosses the boundary without deducting usage.\n- metered: Prices the whole call as monetary overage, using the overage card or USD provider cost plus markup.","example":"metered"},"active":{"type":"boolean","description":"Whether the scope has exhausted its included credits or allowance.","example":false},"unsettled":{"type":"string","pattern":"^-?\\d+(\\.\\d+)?(e[+-]?\\d+)?$/i","description":"Unsettled monetary consumption or used allowance units, in the accompanying denomination.","example":"12.5"}},"required":["currency","mode","active","unsettled"],"description":"Overage policy, current boundary status and unsettled monetary balance; null in wallet mode.","example":{"currency":"USD","mode":"metered","active":false,"unsettled":"0"},"isRequired":true,"uniqueKey":"agents.items.[INDEX].overage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"agents.items.[INDEX].overage","typeLabel":"object | null"}},"required":["agent_slug","mode","balance","blocked","meters","overage"],"uniqueKey":"agents.items.[INDEX]","typeLabel":"object"},"description":"Agent scopes with their own policy or consumption history.","example":[],"isRequired":true,"uniqueKey":"agents","typeLabel":"object[]"}},"required":["agent_slug","mode","balance","blocked","policy","meters","credits","overage","last_settled_at","agents"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"agent_slug":"support","mode":"wallet","balance":{"currency":"USD","denomination":"minor_units","wallet":"10000","unsettled":"12.5","available":"9987.5"},"blocked":false,"policy":null,"meters":[{"key":"daily","included_units":"10000","used_units":"2500","remaining_units":"7500","window_started_at":"2026-09-02T00:00:00Z","resets_at":"2026-09-03T00:00:00Z"}],"credits":null,"overage":{"currency":"USD","mode":"metered","active":false,"unsettled":"0"},"last_settled_at":"2026-09-02T00:00:00Z","agents":[]}}},"exampleType":"generated"}},"exampleType":"generated"},"d8032b14-bfc0-4971-956f-3165cb58962c":{"description":"Invalid request.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"fc2b0afb-f526-446e-9402-e7bea0eef263":{"description":"Customer not found","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"e0c58e6e-17de-40ab-847a-1efa654f4d7a":{"description":"The request conflicts with the current configuration.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"469fe341-ffee-4f28-b415-3dc7c73afcc9":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearer"}}},"servers":{"558fe1ad-2436-4db0-9a94-8a05e02f1824":{"url":"https://api.hyperline.co"},"8e84696b-4799-41b0-a022-0969d81ba65a":{"url":"https://sandbox.api.hyperline.co"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"}]},"originalFileLocation":"api-reference/openapi-main.json"},"subdomain":"hyperline","siteName":"Hyperline","title":"Get billing balance - Hyperline","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-13T09:21:05.895Z","originalFileLocation":"api-reference/endpoints/ai->-billing/get-billing-balance.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Get the live shared-pool balance and agent scopes, or the effective balance for agent_slug with fallback to the shared pool.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Hyperline\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get billing balance - Hyperline\">\u003cmeta data-mint-head property=\"og:description\" content=\"Get the live shared-pool balance and agent scopes, or the effective balance for agent_slug with fallback to the shared pool.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Hyperline\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.hyperline.co/api-reference/endpoints/ai-\u0026gt;-billing/get-billing-balance\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://app.hyperline.co/auth/background.svg\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get billing balance - Hyperline\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Get the live shared-pool balance and agent scopes, or the effective balance for agent_slug with fallback to the shared pool.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://app.hyperline.co/auth/background.svg\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/hyperline/XK0z6uK15Gv1fOA-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Hyperline\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1A1A1A\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.hyperline.co/api-reference/endpoints/ai-\u0026gt;-billing/get-billing-balance\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/ai-%3E-billing/get-billing-balance.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.hyperline.co/#organization\",\"name\":\"Hyperline\",\"url\":\"https://docs.hyperline.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/hyperline/G-7ZQgHUOVHWwtUN/layout/logo-dark.png?fit=max\u0026auto=format\u0026n=G-7ZQgHUOVHWwtUN\u0026q=85\u0026s=2521f5f5ce4977d387d12aa169a8ee55\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.hyperline.co#website\",\"name\":\"Hyperline\",\"url\":\"https://docs.hyperline.co\",\"publisher\":{\"@id\":\"https://docs.hyperline.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/ai-%3E-billing/get-billing-balance#webpage\",\"url\":\"https://docs.hyperline.co/api-reference/endpoints/ai-%3E-billing/get-billing-balance\",\"name\":\"Get billing balance\",\"description\":\"Get the live shared-pool balance and agent scopes, or the effective balance for agent_slug with fallback to the shared pool.\",\"dateModified\":\"2026-10-13T09:21:05.895Z\",\"isPartOf\":{\"@id\":\"https://docs.hyperline.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/ai-%3E-billing/get-billing-balance#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/ai-%3E-billing/get-billing-balance#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API reference\",\"item\":\"https://docs.hyperline.co/api-reference/endpoints/accounting-%3E-accounts/get-ledger-account\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Agents\",\"item\":\"https://docs.hyperline.co/api-reference/endpoints/ai-%3E-costs/list-cost-catalog\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Billing\",\"item\":\"https://docs.hyperline.co/api-reference/endpoints/ai-%3E-costs/list-cost-catalog\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Get billing balance\",\"item\":\"https://docs.hyperline.co/api-reference/endpoints/ai-%3E-billing/get-billing-balance\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/ai-%3E-billing/get-billing-balance#apireference\",\"headline\":\"Get billing balance\",\"name\":\"Get billing balance\",\"description\":\"Get the live shared-pool balance and agent scopes, or the effective balance for agent_slug with fallback to the shared pool.\",\"url\":\"https://docs.hyperline.co/api-reference/endpoints/ai-%3E-billing/get-billing-balance\",\"mainEntityOfPage\":{\"@id\":\"https://docs.hyperline.co/api-reference/endpoints/ai-%3E-billing/get-billing-balance#webpage\"},\"image\":\"https://app.hyperline.co/auth/background.svg\",\"dateModified\":\"2026-10-13T09:21:05.895Z\",\"publisher\":{\"@id\":\"https://docs.hyperline.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.hyperline.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Hyperline\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Hyperline\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoints/ai-%3E-billing/get-billing-balance.md","siteName":"Hyperline","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/docs"}]},{"tab":"Developers","icon":"code","groups":[{"group":"Technical documentation","pages":[{"title":"Hyperline for developers","sidebarTitle":"Getting started","mode":"wide","href":"/developers/getting-started"},{"title":"Authentication","href":"/developers/authentication"}]},{"group":"API fundamentals","pages":[{"title":"Pagination and filtering","href":"/developers/pagination"},{"title":"Error handling","href":"/developers/error-handling"},{"title":"Rate limiting","href":"/developers/rate-limiting"},{"title":"Idempotent requests","href":"/developers/idempotent-requests"},{"title":"Currency amounts","href":"/developers/amount"},{"title":"Dates \u0026 timezones","href":"/developers/dates-and-timezones"},{"title":"API upgrades","href":"/developers/upgrades"}]},{"group":"AI / LLMs","pages":[{"title":"Build with LLMs","href":"/developers/ai/overview"},{"title":"Hyperline MCP","sidebarTitle":"MCP server","href":"/developers/ai/mcp"},{"title":"Hyperline CLI","sidebarTitle":"CLI","href":"/developers/ai/cli"}]},{"group":"Integrations","pages":[{"title":"React components","href":"/developers/react-components"},{"title":"Third-party app","href":"/developers/third-party-app"},{"title":"Webhooks","href":"/developers/webhooks"}]},{"group":"API reference","pages":[{"group":"Accounting","tag":"69","expanded":false,"pages":[{"group":"Accounts","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/accounting/accounts/{id}","title":"Get ledger account","href":"/api-reference/endpoints/accounting->-accounts/get-ledger-account"},{"openapi":"get /v1/accounting/accounts","title":"List ledger accounts","href":"/api-reference/endpoints/accounting->-accounts/list-ledger-accounts"},{"openapi":"get /v1/accounting/primary-ledger/accounts","title":"List primary accounts","href":"/api-reference/endpoints/accounting->-accounts/list-primary-accounts"},{"openapi":"post /v1/accounting/accounts","title":"Create ledger account","href":"/api-reference/endpoints/accounting->-accounts/create-ledger-account"},{"openapi":"put /v1/accounting/accounts/{id}","title":"Update ledger account","href":"/api-reference/endpoints/accounting->-accounts/update-ledger-account"},{"openapi":"delete /v1/accounting/accounts/{id}","title":"Delete ledger account","href":"/api-reference/endpoints/accounting->-accounts/delete-ledger-account"}]},{"group":"Journal entries","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/accounting/journal-entries/{id}","title":"Get journal entry","href":"/api-reference/endpoints/accounting->-journal-entries/get-journal-entry"},{"openapi":"get /v1/accounting/journal-entries","title":"List journal entries","href":"/api-reference/endpoints/accounting->-journal-entries/list-journal-entries"},{"openapi":"get /v1/accounting/journal-entry-lines","title":"List journal entry lines","href":"/api-reference/endpoints/accounting->-journal-entries/list-journal-entry-lines"},{"openapi":"post /v1/accounting/journal-entries","title":"Create journal entry","href":"/api-reference/endpoints/accounting->-journal-entries/create-journal-entry"},{"openapi":"post /v1/accounting/journal-entries/recognition-preview","title":"Preview recognition schedule","href":"/api-reference/endpoints/accounting->-journal-entries/preview-recognition-schedule"}]},{"group":"Ledgers","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/accounting/ledgers/{id}","title":"Get ledger","href":"/api-reference/endpoints/accounting->-ledgers/get-ledger"},{"openapi":"get /v1/accounting/ledgers/{id}/close","title":"Get ledger close state","href":"/api-reference/endpoints/accounting->-ledgers/get-ledger-close-state"},{"openapi":"get /v1/accounting/ledgers","title":"List ledgers","href":"/api-reference/endpoints/accounting->-ledgers/list-ledgers"},{"openapi":"get /v1/accounting/ledgers/{id}/close-events","title":"List ledger close events","href":"/api-reference/endpoints/accounting->-ledgers/list-ledger-close-events"},{"openapi":"post /v1/accounting/ledgers","title":"Create ledger","href":"/api-reference/endpoints/accounting->-ledgers/create-ledger"},{"openapi":"put /v1/accounting/ledgers/{id}","title":"Update ledger","href":"/api-reference/endpoints/accounting->-ledgers/update-ledger"},{"openapi":"post /v1/accounting/ledgers/{id}/close","title":"Close ledger period","href":"/api-reference/endpoints/accounting->-ledgers/close-ledger-period"},{"openapi":"post /v1/accounting/ledgers/{id}/reopen","title":"Reopen ledger period","href":"/api-reference/endpoints/accounting->-ledgers/reopen-ledger-period"},{"openapi":"delete /v1/accounting/ledgers/{id}","title":"Delete ledger","href":"/api-reference/endpoints/accounting->-ledgers/delete-ledger"}]},{"group":"Reports","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"post /v1/accounting/general-ledger/export","title":"Export general ledger","href":"/api-reference/endpoints/accounting->-reports/export-general-ledger"},{"openapi":"post /v1/accounting/income-statement/export","title":"Export income statement","href":"/api-reference/endpoints/accounting->-reports/export-income-statement"}]},{"group":"Revenue policies","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/accounting/revenue-policies/{id}","title":"Get revenue policy","href":"/api-reference/endpoints/accounting->-revenue-policies/get-revenue-policy"},{"openapi":"get /v1/accounting/contract-assessments/{id}","title":"Get contract assessment","href":"/api-reference/endpoints/accounting->-revenue-policies/get-contract-assessment"},{"openapi":"get /v1/accounting/revenue-policies","title":"List revenue policies","href":"/api-reference/endpoints/accounting->-revenue-policies/list-revenue-policies"},{"openapi":"get /v1/accounting/standalone-selling-prices","title":"List standalone selling prices","href":"/api-reference/endpoints/accounting->-revenue-policies/list-standalone-selling-prices"},{"openapi":"get /v1/accounting/contract-assessments","title":"List contract assessments","href":"/api-reference/endpoints/accounting->-revenue-policies/list-contract-assessments"},{"openapi":"get /v1/accounting/exceptions","title":"List accounting exceptions","href":"/api-reference/endpoints/accounting->-revenue-policies/list-accounting-exceptions"},{"openapi":"post /v1/accounting/revenue-policies","title":"Create revenue policy","href":"/api-reference/endpoints/accounting->-revenue-policies/create-revenue-policy"},{"openapi":"post /v1/accounting/revenue-policies/{id}/versions","title":"Create revenue policy version","href":"/api-reference/endpoints/accounting->-revenue-policies/create-revenue-policy-version"},{"openapi":"post /v1/accounting/standalone-selling-prices","title":"Create standalone selling price","href":"/api-reference/endpoints/accounting->-revenue-policies/create-standalone-selling-price"},{"openapi":"put /v1/accounting/revenue-policies/{id}","title":"Update revenue policy","href":"/api-reference/endpoints/accounting->-revenue-policies/update-revenue-policy"},{"openapi":"put /v1/accounting/revenue-policies/{id}/versions/{version_id}","title":"Update revenue policy version","href":"/api-reference/endpoints/accounting->-revenue-policies/update-revenue-policy-version"},{"openapi":"post /v1/accounting/exceptions/{id}/approve","title":"Approve accounting exception","href":"/api-reference/endpoints/accounting->-revenue-policies/approve-accounting-exception"},{"openapi":"post /v1/accounting/contract-assessments/{id}/versions/{version}/approve","title":"Approve contract assessment version","href":"/api-reference/endpoints/accounting->-revenue-policies/approve-contract-assessment-version"},{"openapi":"post /v1/accounting/revenue-policies/{id}/archive","title":"Archive revenue policy","href":"/api-reference/endpoints/accounting->-revenue-policies/archive-revenue-policy"},{"openapi":"get /v1/accounting/exceptions/count","title":"Count contracts with accounting exceptions","href":"/api-reference/endpoints/accounting->-revenue-policies/count-contracts-with-accounting-exceptions"},{"openapi":"post /v1/accounting/exceptions/bulk-decision","title":"Decide accounting exceptions in bulk","href":"/api-reference/endpoints/accounting->-revenue-policies/decide-accounting-exceptions-in-bulk"},{"openapi":"post /v1/accounting/exceptions/{id}/dismiss","title":"Dismiss accounting exception","href":"/api-reference/endpoints/accounting->-revenue-policies/dismiss-accounting-exception"},{"openapi":"post /v1/accounting/contract-assessments/{id}/deliveries","title":"Mark contract obligation delivered","href":"/api-reference/endpoints/accounting->-revenue-policies/mark-contract-obligation-delivered"},{"openapi":"post /v1/accounting/contract-assessments/{id}/overrides","title":"Override contract assessment input","href":"/api-reference/endpoints/accounting->-revenue-policies/override-contract-assessment-input"},{"openapi":"post /v1/accounting/revenue-policies/accounts-preview","title":"Preview obligation accounts","href":"/api-reference/endpoints/accounting->-revenue-policies/preview-obligation-accounts"},{"openapi":"get /v1/accounting/revenue-policies/{id}/running-contracts-preview","title":"Preview running contracts of revenue policy","href":"/api-reference/endpoints/accounting->-revenue-policies/preview-running-contracts-of-revenue-policy"},{"openapi":"post /v1/accounting/revenue-policies/{id}/versions/{version_id}/publish","title":"Publish revenue policy version","href":"/api-reference/endpoints/accounting->-revenue-policies/publish-revenue-policy-version"},{"openapi":"post /v1/accounting/contract-assessments/{id}/versions/{version}/reject","title":"Reject contract assessment version","href":"/api-reference/endpoints/accounting->-revenue-policies/reject-contract-assessment-version"},{"openapi":"post /v1/accounting/contract-assessments/{id}/overrides/{decision_id}/revoke","title":"Revoke contract assessment override","href":"/api-reference/endpoints/accounting->-revenue-policies/revoke-contract-assessment-override"},{"openapi":"post /v1/accounting/contract-assessments/{id}/deliveries/{decision_id}/revoke","title":"Revoke contract obligation delivery","href":"/api-reference/endpoints/accounting->-revenue-policies/revoke-contract-obligation-delivery"},{"openapi":"delete /v1/accounting/contract-assessments/{id}","title":"Delete contract assessment","href":"/api-reference/endpoints/accounting->-revenue-policies/delete-contract-assessment"}]},{"group":"Revenue recognition","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/accounting/revrec/waterfall","title":"Get revenue recognition waterfall","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-revenue-recognition-waterfall"},{"openapi":"get /v1/accounting/revrec/waterfall/cell","title":"Get revenue recognition waterfall cell","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-revenue-recognition-waterfall-cell"},{"openapi":"get /v1/accounting/revrec/unbilled","title":"Get unbilled revenue","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-unbilled-revenue"},{"openapi":"get /v1/accounting/revrec/schedules/{id}","title":"Get revenue recognition schedule","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-revenue-recognition-schedule"},{"openapi":"get /v1/accounting/revrec/invoices/{invoice_id}/contract-billing","title":"Get invoice contract billing","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-invoice-contract-billing"},{"openapi":"get /v1/accounting/overview","title":"Get accounting overview","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-accounting-overview"},{"openapi":"get /v1/accounting/revrec/slices/{id}","title":"Get revenue recognition slice","href":"/api-reference/endpoints/accounting->-revenue-recognition/get-revenue-recognition-slice"},{"openapi":"get /v1/accounting/revrec/schedules","title":"List revenue recognition schedules","href":"/api-reference/endpoints/accounting->-revenue-recognition/list-revenue-recognition-schedules"},{"openapi":"get /v1/accounting/revrec/schedules/{schedule_id}/adjustments","title":"List revenue recognition adjustments","href":"/api-reference/endpoints/accounting->-revenue-recognition/list-revenue-recognition-adjustments"},{"openapi":"post /v1/accounting/revrec/recognized-summary/export","title":"Export recognized revenue summary","href":"/api-reference/endpoints/accounting->-revenue-recognition/export-recognized-revenue-summary"},{"openapi":"post /v1/accounting/revrec/waterfall/export","title":"Export revenue recognition waterfall","href":"/api-reference/endpoints/accounting->-revenue-recognition/export-revenue-recognition-waterfall"},{"openapi":"post /v1/accounting/revrec/schedules/{schedule_id}/reshape/preview","title":"Preview revenue recognition reshape","href":"/api-reference/endpoints/accounting->-revenue-recognition/preview-revenue-recognition-reshape"},{"openapi":"post /v1/accounting/revrec/schedules/{schedule_id}/reshape","title":"Reshape revenue recognition schedule","href":"/api-reference/endpoints/accounting->-revenue-recognition/reshape-revenue-recognition-schedule"}]},{"group":"Rules","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/accounting/rules/tree","title":"Get accounting rule tree","href":"/api-reference/endpoints/accounting->-rules/get-accounting-rule-tree"},{"openapi":"post /v1/accounting/rules/defaults","title":"Get rule defaults","href":"/api-reference/endpoints/accounting->-rules/get-rule-defaults"},{"openapi":"get /v1/accounting/rules/{id}","title":"Get accounting rule","href":"/api-reference/endpoints/accounting->-rules/get-accounting-rule"},{"openapi":"get /v1/accounting/rules","title":"List accounting rules","href":"/api-reference/endpoints/accounting->-rules/list-accounting-rules"},{"openapi":"post /v1/accounting/rules","title":"Create accounting rule","href":"/api-reference/endpoints/accounting->-rules/create-accounting-rule"},{"openapi":"put /v1/accounting/rules/{id}","title":"Update accounting rule","href":"/api-reference/endpoints/accounting->-rules/update-accounting-rule"},{"openapi":"post /v1/accounting/rules/resolve","title":"Resolve accounting rule","href":"/api-reference/endpoints/accounting->-rules/resolve-accounting-rule"},{"openapi":"delete /v1/accounting/rules/{id}","title":"Delete accounting rule","href":"/api-reference/endpoints/accounting->-rules/delete-accounting-rule"}]}]},{"group":"Agents","tag":"39","expanded":false,"pages":[{"group":"Billing","icon":"arrow-turn-down-right","expanded":false,"pages":[{"group":"Costs","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/ai/billing/costs","title":"List cost catalog","href":"/api-reference/endpoints/ai->-costs/list-cost-catalog"},{"openapi":"post /v1/ai/billing/costs/items","title":"Create custom cost item","href":"/api-reference/endpoints/ai->-costs/create-custom-cost-item"},{"openapi":"delete /v1/ai/billing/costs/items/{id}","title":"Remove custom cost item","href":"/api-reference/endpoints/ai->-costs/remove-custom-cost-item"},{"openapi":"delete /v1/ai/billing/costs/overrides/{id}","title":"Remove provider cost override","href":"/api-reference/endpoints/ai->-costs/remove-provider-cost-override"},{"openapi":"put /v1/ai/billing/costs/items/{id}","title":"Replace custom cost item","href":"/api-reference/endpoints/ai->-costs/replace-custom-cost-item"},{"openapi":"put /v1/ai/billing/costs/overrides","title":"Set provider cost override","href":"/api-reference/endpoints/ai->-costs/set-provider-cost-override"}]},{"group":"Plans","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/ai/billing/plans/default","title":"Get default billing plan","href":"/api-reference/endpoints/ai->-billing/get-default-billing-plan"},{"openapi":"get /v1/ai/billing/plans/{id}","title":"Get billing plan","href":"/api-reference/endpoints/ai->-billing/get-billing-plan"},{"openapi":"get /v1/ai/billing/plans","title":"List billing plans","href":"/api-reference/endpoints/ai->-billing/list-billing-plans"},{"openapi":"post /v1/ai/billing/plans","title":"Create billing plan","href":"/api-reference/endpoints/ai->-billing/create-billing-plan"},{"openapi":"post /v1/ai/billing/customers/{id}/apply-default-plan","title":"Apply default billing plan","href":"/api-reference/endpoints/ai->-billing/apply-default-billing-plan"},{"openapi":"delete /v1/ai/billing/plans/default","title":"Clear default billing plan","href":"/api-reference/endpoints/ai->-billing/clear-default-billing-plan"},{"openapi":"put /v1/ai/billing/plans/{id}","title":"Replace billing plan","href":"/api-reference/endpoints/ai->-billing/replace-billing-plan"},{"openapi":"put /v1/ai/billing/plans/default","title":"Set default billing plan","href":"/api-reference/endpoints/ai->-billing/set-default-billing-plan"},{"openapi":"delete /v1/ai/billing/plans/{id}","title":"Delete billing plan","href":"/api-reference/endpoints/ai->-billing/delete-billing-plan"}]},{"group":"Policies","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/ai/billing/customers/{id}/policies/default","title":"Get default billing policy","href":"/api-reference/endpoints/ai->-billing/get-default-billing-policy"},{"openapi":"get /v1/ai/billing/customers/{id}/policies/agents/{agent_slug}","title":"Get billing policy","href":"/api-reference/endpoints/ai->-billing/get-billing-policy"},{"openapi":"get /v1/ai/billing/customers/{id}/policies","title":"List billing policies","href":"/api-reference/endpoints/ai->-billing/list-billing-policies"},{"openapi":"put /v1/ai/billing/customers/{id}/policies/agents/{agent_slug}","title":"Configure billing policy","href":"/api-reference/endpoints/ai->-billing/configure-billing-policy"},{"openapi":"put /v1/ai/billing/customers/{id}/policies/default","title":"Configure default billing policy","href":"/api-reference/endpoints/ai->-billing/configure-default-billing-policy"},{"openapi":"delete /v1/ai/billing/customers/{id}/policies/agents/{agent_slug}","title":"Remove billing policy","href":"/api-reference/endpoints/ai->-billing/remove-billing-policy"},{"openapi":"delete /v1/ai/billing/customers/{id}/policies/default","title":"Remove default billing policy","href":"/api-reference/endpoints/ai->-billing/remove-default-billing-policy"}]},{"group":"Rate cards","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/ai/billing/rate-cards/{id}","title":"Get rate card","href":"/api-reference/endpoints/ai->-billing/get-rate-card"},{"openapi":"get /v1/ai/billing/products/{id}/rate-card","title":"Get product AI rate card","href":"/api-reference/endpoints/ai->-billing/get-product-ai-rate-card"},{"openapi":"get /v1/ai/billing/rate-cards","title":"List rate cards","href":"/api-reference/endpoints/ai->-billing/list-rate-cards"},{"openapi":"post /v1/ai/billing/rate-cards","title":"Create rate card","href":"/api-reference/endpoints/ai->-billing/create-rate-card"},{"openapi":"delete /v1/ai/billing/products/{id}/rate-card","title":"Clear product AI rate card","href":"/api-reference/endpoints/ai->-billing/clear-product-ai-rate-card"},{"openapi":"put /v1/ai/billing/rate-cards/{id}","title":"Replace rate card","href":"/api-reference/endpoints/ai->-billing/replace-rate-card"},{"openapi":"put /v1/ai/billing/products/{id}/rate-card","title":"Set product AI rate card","href":"/api-reference/endpoints/ai->-billing/set-product-ai-rate-card"},{"openapi":"delete /v1/ai/billing/rate-cards/{id}","title":"Delete rate card","description":"Delete an unused rate card, or return 409 while a plan, product or policy references it.","href":"/api-reference/endpoints/ai->-billing/delete-rate-card"}]},{"group":"Usage","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/ai/billing/customers/{id}/balance","title":"Get billing balance","href":"/api-reference/endpoints/ai->-billing/get-billing-balance"},{"openapi":"get /v1/ai/billing/customers/{id}/consumption","title":"List consumption","description":"List billed ledger entries with take/skip, dates and overage filters; omitted agent_slug includes all scopes and an empty string selects the shared pool.","href":"/api-reference/endpoints/ai->-billing/list-consumption"},{"openapi":"post /v1/ai/billing/customers/{id}/windows/reset","title":"Reset allowance windows","href":"/api-reference/endpoints/ai->-billing/reset-allowance-windows"}]}]},{"group":"Ingest","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/ai/billing/snapshot","title":"Get AI billing snapshot","href":"/api-reference/endpoints/ai->-ingest/get-ai-billing-snapshot"},{"openapi":"post /v1/ai/billing/check","title":"Check AI spend allowance","href":"/api-reference/endpoints/ai->-ingest/check-ai-spend-allowance"},{"openapi":"post /v1/ai/billing/consume","title":"Consume AI usage","href":"/api-reference/endpoints/ai->-ingest/consume-ai-usage"},{"openapi":"post /v1/ai/calls","title":"Ingest AI calls","href":"/api-reference/endpoints/ai->-ingest/ingest-ai-calls"}]},{"group":"Monitoring","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/agents/monitoring/analyses/{id}","title":"Get monitoring analysis","href":"/api-reference/endpoints/ai->-monitoring/get-monitoring-analysis"},{"openapi":"get /v1/agents/monitoring/analyses","title":"List monitoring analyses","href":"/api-reference/endpoints/ai->-monitoring/list-monitoring-analyses"}]}]},{"group":"Approvals","tag":"12","expanded":false,"pages":[{"group":"Delegations","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/approvals/delegations/{id}","title":"Get approval delegation","href":"/api-reference/endpoints/approval->-delegations/get-approval-delegation"},{"openapi":"get /v1/approvals/delegations","title":"List approval delegations","href":"/api-reference/endpoints/approval->-delegations/list-approval-delegations"},{"openapi":"post /v1/approvals/delegations","title":"Create approval delegation","href":"/api-reference/endpoints/approval->-delegations/create-approval-delegation"},{"openapi":"post /v1/approvals/delegations/{id}/revoke","title":"Revoke approval delegation","href":"/api-reference/endpoints/approval->-delegations/revoke-approval-delegation"}]},{"group":"Requests","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/approvals/requests/{id}","title":"Get approval request","href":"/api-reference/endpoints/approval->-requests/get-approval-request"},{"openapi":"post /v1/approvals/requests/{id}/approve","title":"Approve request","href":"/api-reference/endpoints/approval->-requests/approve-request"},{"openapi":"post /v1/approvals/requests/{id}/reject","title":"Reject request","href":"/api-reference/endpoints/approval->-requests/reject-request"}]},{"group":"Workflows","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/approvals/workflows/{id}","title":"Get approval workflow","href":"/api-reference/endpoints/approval->-workflows/get-approval-workflow"},{"openapi":"get /v1/approvals/workflows","title":"List approval workflows","href":"/api-reference/endpoints/approval->-workflows/list-approval-workflows"},{"openapi":"post /v1/approvals/workflows","title":"Create approval workflow","href":"/api-reference/endpoints/approval->-workflows/create-approval-workflow"},{"openapi":"put /v1/approvals/workflows/{id}","title":"Update approval workflow","href":"/api-reference/endpoints/approval->-workflows/update-approval-workflow"},{"openapi":"delete /v1/approvals/workflows/{id}","title":"Delete approval workflow","href":"/api-reference/endpoints/approval->-workflows/delete-approval-workflow"}]}]},{"group":"Audit logs","tag":"1","expanded":false,"pages":[{"openapi":"get /v1/audit-logs","title":"List audit logs","href":"/api-reference/endpoints/audit-logs/list-audit-logs"}]},{"group":"Catalog","tag":"47","expanded":false,"pages":[{"group":"Coupons","icon":"arrow-turn-down-right","expanded":false,"pages":[{"group":"Promotion codes","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/promotion-codes/{id}","title":"Get promotion code","href":"/api-reference/endpoints/coupons->-promotion-codes/get-promotion-code"},{"openapi":"get /v1/promotion-codes","title":"List promotion codes","href":"/api-reference/endpoints/coupons->-promotion-codes/list-promotion-codes"},{"openapi":"post /v1/promotion-codes","title":"Create promotion code","href":"/api-reference/endpoints/coupons->-promotion-codes/create-promotion-code"},{"openapi":"patch /v1/promotion-codes/{id}","title":"Update promotion code","href":"/api-reference/endpoints/coupons->-promotion-codes/update-promotion-code"},{"openapi":"delete /v1/promotion-codes/{id}","title":"Delete promotion code","href":"/api-reference/endpoints/coupons->-promotion-codes/delete-promotion-code"}]},{"openapi":"get /v1/coupons/{id}","title":"Get coupon","href":"/api-reference/endpoints/coupons/get-coupon"},{"openapi":"get /v1/coupons","title":"List coupons","href":"/api-reference/endpoints/coupons/list-coupons"},{"openapi":"post /v1/coupons","title":"Create coupon","href":"/api-reference/endpoints/coupons/create-coupon"},{"openapi":"put /v1/coupons/{id}","title":"Update coupon","href":"/api-reference/endpoints/coupons/update-coupon"},{"openapi":"delete /v1/coupons/{id}","title":"Delete coupon","href":"/api-reference/endpoints/coupons/delete-coupon"}]},{"group":"Features","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/features/{code}","title":"Get feature","href":"/api-reference/endpoints/features/get-feature"},{"openapi":"get /v1/features","title":"List features","href":"/api-reference/endpoints/features/list-features"},{"openapi":"post /v1/features","title":"Create feature","href":"/api-reference/endpoints/features/create-feature"},{"openapi":"put /v1/features/{code}","title":"Update feature","href":"/api-reference/endpoints/features/update-feature"},{"openapi":"put /v1/features/{code}/archive","title":"Archive feature","href":"/api-reference/endpoints/features/archive-feature"},{"openapi":"put /v1/features/{code}/unarchive","title":"Unarchive feature","href":"/api-reference/endpoints/features/unarchive-feature"},{"openapi":"delete /v1/features/{code}","title":"Delete feature","href":"/api-reference/endpoints/features/delete-feature"}]},{"group":"Price books","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/price-books/{id}","title":"Get price book","href":"/api-reference/endpoints/price-books/get-price-book"},{"openapi":"get /v1/price-books","title":"List price books","href":"/api-reference/endpoints/price-books/list-price-books"},{"openapi":"post /v1/price-books","title":"Create price book","href":"/api-reference/endpoints/price-books/create-price-book"},{"openapi":"put /v1/price-books/{id}","title":"Update price book","href":"/api-reference/endpoints/price-books/update-price-book"},{"openapi":"post /v1/price-books/{id}/products","title":"Add products to price book","href":"/api-reference/endpoints/price-books/add-products-to-price-book"},{"openapi":"delete /v1/price-books/{id}/products/{productId}","title":"Remove product from price book","href":"/api-reference/endpoints/price-books/remove-product-from-price-book"},{"openapi":"delete /v1/price-books/{id}","title":"Delete price book","href":"/api-reference/endpoints/price-books/delete-price-book"}]},{"group":"Price configurations","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/price-configurations/{id}","title":"Get price configuration","href":"/api-reference/endpoints/price-configurations/get-price-configuration"},{"openapi":"get /v1/price-configurations","title":"List price configurations","href":"/api-reference/endpoints/price-configurations/list-price-configurations"},{"openapi":"post /v1/price-configurations","title":"Create price configuration","href":"/api-reference/endpoints/price-configurations/create-price-configuration"},{"openapi":"put /v1/price-configurations/{id}/prices","title":"Update prices","href":"/api-reference/endpoints/price-configurations/update-prices"},{"openapi":"delete /v1/price-configurations/{id}","title":"Delete price configuration","href":"/api-reference/endpoints/price-configurations/delete-price-configuration"}]},{"group":"Products","icon":"arrow-turn-down-right","expanded":false,"pages":[{"group":"Features","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/products/{id}/features","title":"List product features","href":"/api-reference/endpoints/products->-features/list-product-features"},{"openapi":"put /v1/products/{id}/features/{code}","title":"Set product feature","href":"/api-reference/endpoints/products->-features/set-product-feature"},{"openapi":"delete /v1/products/{id}/features/{code}","title":"Delete product feature","href":"/api-reference/endpoints/products->-features/delete-product-feature"}]},{"openapi":"get /v1/products/{id}","title":"Get product","href":"/api-reference/endpoints/products/get-product"},{"openapi":"get /v1/products","title":"List products","href":"/api-reference/endpoints/products/list-products"},{"openapi":"post /v1/products","title":"Create product","href":"/api-reference/endpoints/products/create-product"},{"openapi":"put /v1/products/{id}","title":"Update product","href":"/api-reference/endpoints/products/update-product"},{"openapi":"put /v1/products/{id}/archive","title":"Archive product","href":"/api-reference/endpoints/products/archive-product"},{"openapi":"put /v1/products/{id}/unarchive","title":"Unarchive product","href":"/api-reference/endpoints/products/unarchive-product"},{"openapi":"delete /v1/products/{id}","title":"Delete product","href":"/api-reference/endpoints/products/delete-product"}]},{"group":"Versioning","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/catalog/versions/draft","title":"Get catalog draft","href":"/api-reference/endpoints/catalog/get-catalog-draft"},{"openapi":"get /v1/catalog/versions/{id}","title":"Get catalog version","href":"/api-reference/endpoints/catalog/get-catalog-version"},{"openapi":"get /v1/catalog/versions","title":"List catalog versions","href":"/api-reference/endpoints/catalog/list-catalog-versions"},{"openapi":"post /v1/catalog/versions/draft","title":"Create catalog draft","href":"/api-reference/endpoints/catalog/create-catalog-draft"},{"openapi":"delete /v1/catalog/versions/draft","title":"Discard catalog draft","href":"/api-reference/endpoints/catalog/discard-catalog-draft"},{"openapi":"get /v1/catalog/export","title":"Export catalog","href":"/api-reference/endpoints/catalog/export-catalog"},{"openapi":"post /v1/catalog/versions/draft/publish","title":"Publish catalog draft","href":"/api-reference/endpoints/catalog/publish-catalog-draft"},{"openapi":"post /v1/catalog/versions/{id}/revert","title":"Revert catalog version","href":"/api-reference/endpoints/catalog/revert-catalog-version"}]}]},{"group":"Custom properties","tag":"4","expanded":false,"pages":[{"openapi":"get /v1/custom-properties","title":"List custom properties","href":"/api-reference/endpoints/custom-properties/list-custom-properties"},{"openapi":"post /v1/custom-properties","title":"Create custom property","href":"/api-reference/endpoints/custom-properties/create-custom-property"},{"openapi":"put /v1/custom-properties/{id}","title":"Update custom property","href":"/api-reference/endpoints/custom-properties/update-custom-property"},{"openapi":"delete /v1/custom-properties/{id}","title":"Delete custom property","href":"/api-reference/endpoints/custom-properties/delete-custom-property"}]},{"group":"Customers","tag":"50","expanded":false,"pages":[{"group":"Address","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/customers/{customerId}/addresses","title":"List addresses","href":"/api-reference/endpoints/customers->-address/list-addresses"},{"openapi":"post /v1/customers/{customerId}/addresses","title":"Create address","href":"/api-reference/endpoints/customers->-address/create-address"},{"openapi":"patch /v1/customers/{customerId}/addresses/{addressId}","title":"Update address","href":"/api-reference/endpoints/customers->-address/update-address"},{"openapi":"delete /v1/customers/{customerId}/addresses/{addressId}","title":"Delete address","href":"/api-reference/endpoints/customers->-address/delete-address"}]},{"group":"Credits","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/customers/{id}/credits/{productId}","title":"Get credit product","href":"/api-reference/endpoints/customers->-credits/get-credit-product"},{"openapi":"get /v1/customers/{id}/credits/{productId}/portal-settings","title":"Get credit portal settings","href":"/api-reference/endpoints/customers->-credits/get-credit-portal-settings"},{"openapi":"get /v1/customers/credits","title":"List all credit products","href":"/api-reference/endpoints/customers->-credits/list-all-credit-products"},{"openapi":"get /v1/customers/{id}/credits","title":"List credit products","href":"/api-reference/endpoints/customers->-credits/list-credit-products"},{"openapi":"get /v1/customers/{id}/credits/{productId}/transactions","title":"List credit transactions","href":"/api-reference/endpoints/customers->-credits/list-credit-transactions"},{"openapi":"post /v1/customers/{id}/credits","title":"Create credit product","href":"/api-reference/endpoints/customers->-credits/create-credit-product"},{"openapi":"post /v1/customers/{id}/credits/{productId}/usage","title":"Create credits usage","href":"/api-reference/endpoints/customers->-credits/create-credits-usage"},{"openapi":"put /v1/customers/{id}/credits/{productId}","title":"Update credit product","href":"/api-reference/endpoints/customers->-credits/update-credit-product"},{"openapi":"patch /v1/customers/{id}/credits/{productId}/transactions/{transactionId}","title":"Update credit topup expiration","href":"/api-reference/endpoints/customers->-credits/update-credit-topup-expiration"},{"openapi":"put /v1/customers/{id}/credits/{productId}/portal-settings","title":"Update credit portal settings","href":"/api-reference/endpoints/customers->-credits/update-credit-portal-settings"},{"openapi":"post /v1/customers/{id}/credits/{productId}/purchase","title":"Purchase credits","href":"/api-reference/endpoints/customers->-credits/purchase-credits"},{"openapi":"post /v1/customers/{id}/credits/{productId}/topup","title":"Topup credits","href":"/api-reference/endpoints/customers->-credits/topup-credits"}]},{"group":"Features","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/customers/{id}/features","title":"Resolve customer features","href":"/api-reference/endpoints/customers->-features/resolve-customer-features"},{"openapi":"put /v1/customers/{id}/features/{code}","title":"Set customer feature","href":"/api-reference/endpoints/customers->-features/set-customer-feature"},{"openapi":"delete /v1/customers/{id}/features/{code}","title":"Delete customer feature","href":"/api-reference/endpoints/customers->-features/delete-customer-feature"}]},{"group":"Lifecycle","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"put /v1/customers/{id}/archive","title":"Archive customer","href":"/api-reference/endpoints/customers/archive-customer"},{"openapi":"put /v1/customers/{id}/unarchive","title":"Unarchive customer","href":"/api-reference/endpoints/customers/unarchive-customer"},{"openapi":"delete /v1/customers/{id}","title":"Delete customer","href":"/api-reference/endpoints/customers/delete-customer"}]},{"group":"Organisations","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/organisations/{id}","title":"Get organisation","href":"/api-reference/endpoints/organisations/get-organisation"},{"openapi":"get /v1/organisations","title":"List organisations","href":"/api-reference/endpoints/organisations/list-organisations"},{"openapi":"patch /v1/organisations/{id}","title":"Patch organisation","href":"/api-reference/endpoints/organisations/patch-organisation"}]},{"group":"Payment methods","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/customers/{id}/payment-methods/{paymentMethodId}","title":"Get payment method","href":"/api-reference/endpoints/customers->-payment-methods/get-payment-method"},{"openapi":"get /v1/customers/{id}/payment-methods","title":"List payment methods","href":"/api-reference/endpoints/customers->-payment-methods/list-payment-methods"},{"openapi":"post /v1/customers/{id}/payment-methods","title":"Create payment method","href":"/api-reference/endpoints/customers->-payment-methods/create-payment-method"},{"openapi":"delete /v1/customers/{id}/payment-methods/{paymentMethodId}","title":"Delete payment method","href":"/api-reference/endpoints/customers->-payment-methods/delete-payment-method"}]},{"group":"Segments","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/customers/segments/{id}","title":"Get segment","href":"/api-reference/endpoints/customers->-segments/get-segment"},{"openapi":"get /v1/customers/segments","title":"List segments","href":"/api-reference/endpoints/customers->-segments/list-segments"},{"openapi":"post /v1/customers/segments","title":"Create segment","href":"/api-reference/endpoints/customers->-segments/create-segment"},{"openapi":"patch /v1/customers/segments/{id}","title":"Update segment","href":"/api-reference/endpoints/customers->-segments/update-segment"},{"openapi":"delete /v1/customers/segments/{id}","title":"Delete segment","href":"/api-reference/endpoints/customers->-segments/delete-segment"}]},{"group":"Shipping","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/customers/{customerId}/shipping","title":"Get shipping destination","href":"/api-reference/endpoints/customers->-shipping/get-shipping-destination"},{"openapi":"put /v1/customers/{customerId}/shipping","title":"Set shipping destination","href":"/api-reference/endpoints/customers->-shipping/set-shipping-destination"}]},{"group":"Usage","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/customers/{id}/usage/{aggregator_id}","title":"Get customer usage for an aggregator","href":"/api-reference/endpoints/customers->-usage/get-customer-usage-for-an-aggregator"},{"openapi":"get /v1/customers/{id}/usage/{aggregator_id}/timeseries","title":"Get customer usage timeseries","href":"/api-reference/endpoints/customers->-usage/get-customer-usage-timeseries"},{"openapi":"get /v1/customers/{id}/usage/{aggregator_id}/events","title":"Get customer usage events","href":"/api-reference/endpoints/customers->-usage/get-customer-usage-events"},{"openapi":"get /v1/customers/{id}/usage","title":"List customer usage","href":"/api-reference/endpoints/customers->-usage/list-customer-usage"}]},{"openapi":"get /v2/customers/{id}","title":"Get customer","href":"/api-reference/endpoints/customers/get-customer"},{"openapi":"get /v1/customers/{id}/portal","title":"Get customer portal","href":"/api-reference/endpoints/customers/get-customer-portal"},{"openapi":"get /v1/customers/{id}/taxes/rates","title":"Get customer tax rates","href":"/api-reference/endpoints/customers/get-customer-tax-rates"},{"openapi":"get /v1/customers/{id}/arr-history","title":"Get customer ARR history","href":"/api-reference/endpoints/customers/get-customer-arr-history"},{"openapi":"get /v1/customers/{id}/valuation","title":"Get customer valuation","href":"/api-reference/endpoints/customers/get-customer-valuation"},{"openapi":"get /v2/customers","title":"List customers","href":"/api-reference/endpoints/customers/list-customers"},{"openapi":"post /v1/customers","title":"Create customer","href":"/api-reference/endpoints/customers/create-customer"},{"openapi":"post /v1/customers/batch","title":"Create customers batch","href":"/api-reference/endpoints/customers/create-customers-batch"},{"openapi":"put /v1/customers/{id}","title":"Update customer","href":"/api-reference/endpoints/customers/update-customer"},{"openapi":"post /v1/customers/providers-bulk-update","title":"Bulk update providers/customers mapping","href":"/api-reference/endpoints/customers/bulk-update-providerscustomers-mapping"}]},{"group":"Files","tag":"4","expanded":false,"pages":[{"openapi":"get /v1/files","title":"List files","href":"/api-reference/endpoints/files/list-files"},{"openapi":"get /v1/files/{id}/download","title":"Download file","href":"/api-reference/endpoints/files/download-file"},{"openapi":"post /v1/files","title":"Create file","href":"/api-reference/endpoints/files/create-file"},{"openapi":"delete /v1/files/{id}","title":"Delete file","href":"/api-reference/endpoints/files/delete-file"}]},{"group":"Integrations","tag":"1","expanded":false,"pages":[{"openapi":"post /v1/integrations/components/token","title":"Create component token","href":"/api-reference/endpoints/integrations/create-component-token"}]},{"group":"Invoicing","tag":"30","expanded":false,"pages":[{"group":"Credit notes","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"post /v1/invoices/{id}/credit-notes","title":"Create credit note","href":"/api-reference/endpoints/invoices/create-credit-note"},{"openapi":"put /v1/invoices/{id}/allocations","title":"Update credit note allocations","href":"/api-reference/endpoints/invoices/update-credit-note-allocations"}]},{"group":"Documents","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v2/invoices/{id}/download","title":"Download invoice","href":"/api-reference/endpoints/invoices/download-invoice"},{"openapi":"post /v1/invoices/send-email","title":"Send invoice emails","href":"/api-reference/endpoints/invoices/send-invoice-emails"},{"openapi":"post /v1/invoices/{id}/upload","title":"Upload PDF to invoice","href":"/api-reference/endpoints/invoices/upload-pdf-to-invoice"}]},{"group":"E-invoices","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/invoices/{id}/electronic-invoices/{system}/download","title":"Download electronic invoice file","href":"/api-reference/endpoints/invoices->-e-invoices/download-electronic-invoice-file"},{"openapi":"post /v1/invoices/{id}/electronic-invoices/{system}/send","title":"Send electronic invoice","href":"/api-reference/endpoints/invoices->-e-invoices/send-electronic-invoice"}]},{"group":"Events","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/invoices/{id}/events","title":"List invoice events","href":"/api-reference/endpoints/invoices->-events/list-invoice-events"}]},{"group":"Invoicing entities","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/invoicing-entities/{id}","title":"Get invoicing entity","href":"/api-reference/endpoints/invoicing-entities/get-invoicing-entity"},{"openapi":"get /v1/invoicing-entities","title":"List invoicing entities","href":"/api-reference/endpoints/invoicing-entities/list-invoicing-entities"},{"openapi":"post /v1/invoicing-entities","title":"Create invoicing entity","href":"/api-reference/endpoints/invoicing-entities/create-invoicing-entity"},{"openapi":"put /v1/invoicing-entities/{id}","title":"Update invoicing entity","href":"/api-reference/endpoints/invoicing-entities/update-invoicing-entity"},{"openapi":"delete /v1/invoicing-entities/{id}","title":"Delete invoicing entity","href":"/api-reference/endpoints/invoicing-entities/delete-invoicing-entity"}]},{"group":"Lifecycle","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"post /v1/invoices/{id}/charge","title":"Charge invoice","href":"/api-reference/endpoints/invoices/charge-invoice"},{"openapi":"post /v1/invoices/{id}/uncollectible","title":"Mark as uncollectible","href":"/api-reference/endpoints/invoices/mark-as-uncollectible"},{"openapi":"post /v1/invoices/{id}/validate","title":"Validate draft invoice","href":"/api-reference/endpoints/invoices/validate-draft-invoice"},{"openapi":"post /v1/invoices/{id}/void","title":"Void invoice","href":"/api-reference/endpoints/invoices/void-invoice"}]},{"group":"Taxes","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/taxes/rates/{id}","title":"Get tax rate","href":"/api-reference/endpoints/taxes/get-tax-rate"},{"openapi":"get /v1/taxes/rates","title":"List tax rates","href":"/api-reference/endpoints/taxes/list-tax-rates"},{"openapi":"post /v1/taxes/rates","title":"Create tax rate","href":"/api-reference/endpoints/taxes/create-tax-rate"},{"openapi":"patch /v1/taxes/rates/{id}","title":"Update tax rate","href":"/api-reference/endpoints/taxes/update-tax-rate"},{"openapi":"delete /v1/taxes/rates/{id}","title":"Delete tax rate","href":"/api-reference/endpoints/taxes/delete-tax-rate"}]},{"group":"Transactions","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"post /v1/invoices/{id}/transactions","title":"Create transaction","href":"/api-reference/endpoints/invoices->-transactions/create-transaction"},{"openapi":"delete /v1/invoices/{id}/transactions/{transactionId}","title":"Delete transaction","href":"/api-reference/endpoints/invoices->-transactions/delete-transaction"}]},{"openapi":"get /v2/invoices/{id}","title":"Get invoice","href":"/api-reference/endpoints/invoices/get-invoice"},{"openapi":"get /v2/invoices","title":"List invoices","href":"/api-reference/endpoints/invoices/list-invoices"},{"openapi":"post /v1/invoices","title":"Create invoice","href":"/api-reference/endpoints/invoices/create-invoice"},{"openapi":"post /v2/invoices/batch","title":"Create invoices","href":"/api-reference/endpoints/invoices/create-invoices"},{"openapi":"patch /v1/invoices/{id}","title":"Update invoice","href":"/api-reference/endpoints/invoices/update-invoice"},{"openapi":"delete /v1/invoices/{id}","title":"Delete invoice","href":"/api-reference/endpoints/invoices/delete-invoice"}]},{"group":"OAuth2","tag":"6","expanded":false,"pages":[{"openapi":"get /oauth/userinfo","title":"Get user info","href":"/api-reference/endpoints/oauth2/get-user-info"},{"openapi":"get /oauth/authorize","title":"Authorize","href":"/api-reference/endpoints/oauth2/authorize"},{"openapi":"post /oauth/tokens","title":"Generate tokens","href":"/api-reference/endpoints/oauth2/generate-tokens"},{"openapi":"get /oauth/callback","title":"OAuth callback","href":"/api-reference/endpoints/oauth2/oauth-callback"},{"openapi":"post /oauth/register","title":"Register OAuth client","href":"/api-reference/endpoints/oauth2/register-oauth-client"},{"openapi":"post /oauth/revoke","title":"Revoke token","href":"/api-reference/endpoints/oauth2/revoke-token"}]},{"group":"Quoting","tag":"32","expanded":false,"pages":[{"group":"Approvals","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/quotes/{id}/approvals","title":"Get quote approvals","href":"/api-reference/endpoints/quotes->-approvals/get-quote-approvals"},{"openapi":"post /v1/quotes/{id}/approve","title":"Approve quote","href":"/api-reference/endpoints/quotes->-approvals/approve-quote"}]},{"group":"Documents","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/quotes/{id}/download","title":"Download quote","href":"/api-reference/endpoints/quotes/download-quote"},{"openapi":"get /v1/quotes/{quoteId}/files/{id}/download","title":"Download quote file","href":"/api-reference/endpoints/quotes/download-quote-file"}]},{"group":"Library","icon":"arrow-turn-down-right","expanded":false,"pages":[{"group":"Clauses","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/contracts/clauses/{id}","title":"Get contract clause","href":"/api-reference/endpoints/contracts->-clauses/get-contract-clause"},{"openapi":"get /v1/contracts/clauses","title":"List contract clauses","href":"/api-reference/endpoints/contracts->-clauses/list-contract-clauses"},{"openapi":"post /v1/contracts/clauses","title":"Create contract clause","href":"/api-reference/endpoints/contracts->-clauses/create-contract-clause"},{"openapi":"put /v1/contracts/clauses/{id}","title":"Update contract clause","href":"/api-reference/endpoints/contracts->-clauses/update-contract-clause"},{"openapi":"delete /v1/contracts/clauses/{id}","title":"Delete contract clause","href":"/api-reference/endpoints/contracts->-clauses/delete-contract-clause"}]},{"group":"Contracts","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/contracts/documents/{id}","title":"Get contract document","href":"/api-reference/endpoints/contracts->-documents/get-contract-document"},{"openapi":"get /v1/contracts/documents","title":"List contract documents","href":"/api-reference/endpoints/contracts->-documents/list-contract-documents"},{"openapi":"post /v1/contracts/documents","title":"Create contract document","href":"/api-reference/endpoints/contracts->-documents/create-contract-document"},{"openapi":"post /v1/contracts/documents/{id}/contents","title":"Create contract document content","href":"/api-reference/endpoints/contracts->-documents/create-contract-document-content"},{"openapi":"put /v1/contracts/documents/{id}","title":"Update contract document","href":"/api-reference/endpoints/contracts->-documents/update-contract-document"},{"openapi":"put /v1/contracts/documents/{id}/contents/{contentId}","title":"Update contract document content","href":"/api-reference/endpoints/contracts->-documents/update-contract-document-content"},{"openapi":"delete /v1/contracts/documents/{id}","title":"Delete contract document","href":"/api-reference/endpoints/contracts->-documents/delete-contract-document"},{"openapi":"delete /v1/contracts/documents/{id}/contents/{contentId}","title":"Delete contract document content","href":"/api-reference/endpoints/contracts->-documents/delete-contract-document-content"}]}]},{"group":"Lifecycle","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"post /v1/quotes/{id}/finalize","title":"Finalize quote","href":"/api-reference/endpoints/quotes/finalize-quote"},{"openapi":"post /v1/quotes/{id}/redraft","title":"Redraft quote","href":"/api-reference/endpoints/quotes/redraft-quote"},{"openapi":"post /v1/quotes/{id}/send","title":"Send quote","href":"/api-reference/endpoints/quotes/send-quote"},{"openapi":"post /v1/quotes/{id}/void","title":"Void quote","href":"/api-reference/endpoints/quotes/void-quote"}]},{"group":"Signatures","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/quotes/{id}/signers","title":"List quote signers","href":"/api-reference/endpoints/quotes/list-quote-signers"},{"openapi":"put /v1/quotes/{id}/signers","title":"Set quote signers","href":"/api-reference/endpoints/quotes/set-quote-signers"},{"openapi":"post /v1/quotes/{id}/sign","title":"Sign quote","href":"/api-reference/endpoints/quotes/sign-quote"}]},{"group":"Templates","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/quotes/templates/{id}","title":"Get quote template","href":"/api-reference/endpoints/quotes->-templates/get-quote-template"},{"openapi":"get /v1/quotes/templates","title":"List quote templates","href":"/api-reference/endpoints/quotes->-templates/list-quote-templates"}]},{"openapi":"get /v1/quotes/{id}","title":"Get quote","href":"/api-reference/endpoints/quotes/get-quote"},{"openapi":"get /v1/quotes/{id}/valuation","title":"Get quote valuation","href":"/api-reference/endpoints/quotes/get-quote-valuation"},{"openapi":"get /v1/quotes","title":"List quotes","href":"/api-reference/endpoints/quotes/list-quotes"},{"openapi":"post /v1/quotes","title":"Create quote","href":"/api-reference/endpoints/quotes/create-quote"},{"openapi":"patch /v1/quotes/{id}","title":"Update quote","href":"/api-reference/endpoints/quotes/update-quote"},{"openapi":"post /v1/quotes/{id}/duplicate","title":"Duplicate quote","href":"/api-reference/endpoints/quotes/duplicate-quote"}]},{"group":"Reports","tag":"5","expanded":false,"pages":[{"group":"Analytics","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/analytics","title":"Get analytics","href":"/api-reference/endpoints/analytics/get-analytics"}]},{"group":"Exports","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/exports/{exportId}","title":"Get export","href":"/api-reference/endpoints/exports/get-export"},{"openapi":"get /v1/exports","title":"List exports","href":"/api-reference/endpoints/exports/list-exports"},{"openapi":"get /v2/exports/{exportId}/download","title":"Download export","href":"/api-reference/endpoints/exports/download-export"},{"openapi":"post /v1/exports","title":"Create export","href":"/api-reference/endpoints/exports/create-export"}]}]},{"group":"Subscriptions","tag":"36","expanded":false,"pages":[{"group":"Billing","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/subscriptions/{id}/estimates","title":"List subscription estimates","href":"/api-reference/endpoints/subscriptions/list-subscription-estimates"},{"openapi":"post /v2/subscriptions/{id}/refresh-seat-products","title":"Refresh seat products","href":"/api-reference/endpoints/subscriptions/refresh-seat-products"},{"openapi":"post /v1/subscriptions/refresh","title":"Refresh subscriptions","href":"/api-reference/endpoints/subscriptions/refresh-subscriptions"}]},{"group":"Changes","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"post /v1/subscriptions/{id}/update","title":"Create subscription update","href":"/api-reference/endpoints/subscriptions/create-subscription-update"},{"openapi":"post /v1/subscriptions/{id}/update-many","title":"Create subscription updates","href":"/api-reference/endpoints/subscriptions/create-subscription-updates"},{"openapi":"post /v1/subscriptions/{id}/simulate-updates","title":"Simulate subscription updates","href":"/api-reference/endpoints/subscriptions/simulate-subscription-updates"}]},{"group":"Lifecycle","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"post /v1/subscriptions/{id}/activate","title":"Activate subscription","href":"/api-reference/endpoints/subscriptions/activate-subscription"},{"openapi":"post /v1/subscriptions/{id}/cancel","title":"Cancel subscription","href":"/api-reference/endpoints/subscriptions/cancel-subscription"},{"openapi":"post /v1/subscriptions/{id}/pause","title":"Pause subscription","href":"/api-reference/endpoints/subscriptions/pause-subscription"},{"openapi":"get /v1/subscriptions/{id}/preview-timeline","title":"Preview subscription timeline","href":"/api-reference/endpoints/subscriptions/preview-subscription-timeline"},{"openapi":"post /v1/subscriptions/{id}/reactivate","title":"Reactivate subscription","href":"/api-reference/endpoints/subscriptions/reactivate-subscription"},{"openapi":"post /v1/subscriptions/{id}/reinstate","title":"Reinstate subscription","href":"/api-reference/endpoints/subscriptions/reinstate-subscription"},{"openapi":"post /v1/subscriptions/{id}/renew","title":"Renew subscription","href":"/api-reference/endpoints/subscriptions/renew-subscription"}]},{"group":"Phases","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v2/subscriptions/{id}/phases/{phaseId}","title":"Get subscription phase","href":"/api-reference/endpoints/subscriptions->-phases/get-subscription-phase"},{"openapi":"get /v2/subscriptions/{id}/phases","title":"List subscription phases","href":"/api-reference/endpoints/subscriptions->-phases/list-subscription-phases"},{"openapi":"post /v2/subscriptions/{id}/next-phase","title":"Transition subscription to next phase","href":"/api-reference/endpoints/subscriptions->-phases/transition-subscription-to-next-phase"}]},{"group":"Templates","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/subscriptions/templates/{id}","title":"Get subscription template","href":"/api-reference/endpoints/subscriptions->-templates/get-subscription-template"},{"openapi":"get /v1/subscriptions/templates","title":"List subscription templates","href":"/api-reference/endpoints/subscriptions->-templates/list-subscription-templates"},{"openapi":"post /v1/subscriptions/templates","title":"Create subscription template","href":"/api-reference/endpoints/subscriptions->-templates/create-subscription-template"},{"openapi":"post /v1/subscriptions/templates/{id}/configurations","title":"Create subscription template configuration","href":"/api-reference/endpoints/subscriptions->-templates/create-subscription-template-configuration"},{"openapi":"patch /v1/subscriptions/templates/{id}","title":"Update subscription template","href":"/api-reference/endpoints/subscriptions->-templates/update-subscription-template"},{"openapi":"put /v1/subscriptions/templates/{templateId}/configurations/{id}","title":"Update subscription template configuration","href":"/api-reference/endpoints/subscriptions->-templates/update-subscription-template-configuration"},{"openapi":"delete /v1/subscriptions/templates/{id}","title":"Delete subscription template","href":"/api-reference/endpoints/subscriptions->-templates/delete-subscription-template"},{"openapi":"delete /v1/subscriptions/templates/{templateId}/configurations/{id}","title":"Delete subscription template configuration","href":"/api-reference/endpoints/subscriptions->-templates/delete-subscription-template-configuration"}]},{"group":"Transitions","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v2/subscriptions/transitions/{id}","title":"Get subscription transition","href":"/api-reference/endpoints/subscriptions->-transitions/get-subscription-transition"},{"openapi":"get /v2/subscriptions/transitions","title":"List subscription transitions","href":"/api-reference/endpoints/subscriptions->-transitions/list-subscription-transitions"},{"openapi":"post /v2/subscriptions/transitions","title":"Create subscription transition","href":"/api-reference/endpoints/subscriptions->-transitions/create-subscription-transition"},{"openapi":"post /v2/subscriptions/transitions/{id}/cancel","title":"Cancel subscription transition","href":"/api-reference/endpoints/subscriptions->-transitions/cancel-subscription-transition"},{"openapi":"post /v2/subscriptions/transitions/preview","title":"Preview subscription transition","href":"/api-reference/endpoints/subscriptions->-transitions/preview-subscription-transition"}]},{"openapi":"get /v2/subscriptions/{id}","title":"Get subscription","href":"/api-reference/endpoints/subscriptions/get-subscription"},{"openapi":"get /v1/subscriptions/{id}/arr-history","title":"Get subscription ARR history","href":"/api-reference/endpoints/subscriptions/get-subscription-arr-history"},{"openapi":"get /v1/subscriptions/{id}/valuation","title":"Get subscription valuation","href":"/api-reference/endpoints/subscriptions/get-subscription-valuation"},{"openapi":"get /v2/subscriptions","title":"List subscriptions","href":"/api-reference/endpoints/subscriptions/list-subscriptions"},{"openapi":"post /v2/subscriptions","title":"Create subscription","href":"/api-reference/endpoints/subscriptions/create-subscription"},{"openapi":"put /v1/subscriptions/{id}/engine","title":"Update subscription engine","href":"/api-reference/endpoints/subscriptions/update-subscription-engine"},{"openapi":"put /v2/subscriptions/{id}","title":"Update subscription","href":"/api-reference/endpoints/subscriptions/update-subscription"}]},{"group":"Third-party apps","tag":"4","expanded":false,"pages":[{"openapi":"get /v1/apps","title":"List apps","href":"/api-reference/endpoints/third-party-apps/list-apps"},{"openapi":"post /v1/apps","title":"Create app","href":"/api-reference/endpoints/third-party-apps/create-app"},{"openapi":"put /v1/apps/{id}","title":"Update app","href":"/api-reference/endpoints/third-party-apps/update-app"},{"openapi":"delete /v1/apps/{id}","title":"Delete app","href":"/api-reference/endpoints/third-party-apps/delete-app"}]},{"group":"Transactions","tag":"11","expanded":false,"pages":[{"group":"Allocations","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"post /v1/transactions/{id}/allocate","title":"Allocate transaction","href":"/api-reference/endpoints/transactions->-allocations/allocate-transaction"},{"openapi":"post /v1/transactions/{id}/unallocate","title":"Unallocate transaction","href":"/api-reference/endpoints/transactions->-allocations/unallocate-transaction"}]},{"group":"Bank accounts","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/bank-accounts/{id}","title":"Get bank account","href":"/api-reference/endpoints/bank-accounts/get-bank-account"},{"openapi":"get /v1/bank-accounts","title":"List bank accounts","href":"/api-reference/endpoints/bank-accounts/list-bank-accounts"},{"openapi":"get /v1/bank-accounts/{id}/transactions","title":"List bank transactions","href":"/api-reference/endpoints/bank-accounts/list-bank-transactions"}]},{"openapi":"post /v1/payments","title":"Create payment","href":"/api-reference/endpoints/payments/create-payment"},{"openapi":"get /v1/transactions/{id}","title":"Get transaction","href":"/api-reference/endpoints/transactions/get-transaction"},{"openapi":"get /v1/transactions","title":"List transactions","href":"/api-reference/endpoints/transactions/list-transactions"},{"openapi":"post /v1/transactions","title":"Create transaction","href":"/api-reference/endpoints/transactions/create-transaction"},{"openapi":"post /v1/transactions/{id}/refund","title":"Refund transaction","href":"/api-reference/endpoints/transactions/refund-transaction"},{"openapi":"delete /v1/transactions/{id}","title":"Delete transaction","href":"/api-reference/endpoints/transactions/delete-transaction"}]},{"group":"Usage","tag":"13","expanded":false,"pages":[{"group":"Aggregators","icon":"arrow-turn-down-right","expanded":false,"pages":[{"group":"Usage","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/aggregators/{id}/usage","title":"Get aggregator usage","href":"/api-reference/endpoints/aggregators->-usage/get-aggregator-usage"},{"openapi":"get /v1/aggregators/{id}/usage/timeseries","title":"Get aggregator usage timeseries","href":"/api-reference/endpoints/aggregators->-usage/get-aggregator-usage-timeseries"},{"openapi":"get /v1/aggregators/{id}/usage/group-by-customer","title":"Get aggregator usage grouped by customer","href":"/api-reference/endpoints/aggregators->-usage/get-aggregator-usage-grouped-by-customer"},{"openapi":"get /v1/aggregators/{id}/usage/events","title":"Get aggregator usage events","href":"/api-reference/endpoints/aggregators->-usage/get-aggregator-usage-events"}]},{"openapi":"get /v1/aggregators/{id}","title":"Get aggregator","href":"/api-reference/endpoints/aggregators/get-aggregator"},{"openapi":"get /v1/aggregators","title":"List aggregators","href":"/api-reference/endpoints/aggregators/list-aggregators"},{"openapi":"post /v1/aggregators","title":"Create aggregator","href":"/api-reference/endpoints/aggregators/create-aggregator"},{"openapi":"put /v1/aggregators/{id}","title":"Update aggregator","href":"/api-reference/endpoints/aggregators/update-aggregator"},{"openapi":"delete /v1/aggregators/{id}","title":"Delete aggregator","href":"/api-reference/endpoints/aggregators/delete-aggregator"}]},{"group":"Billable events","icon":"arrow-turn-down-right","expanded":false,"pages":[{"openapi":"get /v1/events","title":"Get events","href":"/api-reference/endpoints/billable-events/get-events"},{"openapi":"post /v1/events","title":"Ingest billable event","href":"/api-reference/endpoints/billable-events/ingest-billable-event"},{"openapi":"post /v1/events/batch","title":"Ingest billable events","href":"/api-reference/endpoints/billable-events/ingest-billable-events"},{"openapi":"delete /v1/events","title":"Delete billable events","href":"/api-reference/endpoints/billable-events/delete-billable-events"}]}]},{"group":"Users","tag":"4","expanded":false,"pages":[{"openapi":"get /v1/users/{id}","title":"Get user","href":"/api-reference/endpoints/users/get-user"},{"openapi":"get /v1/users","title":"List users","href":"/api-reference/endpoints/users/list-users"},{"openapi":"get /v1/users/roles/{id}","title":"Get user role","href":"/api-reference/endpoints/users->-roles/get-user-role"},{"openapi":"get /v1/users/roles","title":"List user roles","href":"/api-reference/endpoints/users->-roles/list-user-roles"}]},{"group":"Wallets","tag":"9","expanded":false,"pages":[{"openapi":"get /v1/wallets/settings","title":"Get wallet settings","href":"/api-reference/endpoints/wallets/get-wallet-settings"},{"openapi":"get /v1/wallets/{id}","title":"Get wallet","href":"/api-reference/endpoints/wallets/get-wallet"},{"openapi":"get /v2/wallets","title":"List wallets","href":"/api-reference/endpoints/wallets/list-wallets"},{"openapi":"get /v1/wallets/{id}/transactions","title":"List wallet transactions","href":"/api-reference/endpoints/wallets/list-wallet-transactions"},{"openapi":"post /v1/wallets","title":"Create wallet","href":"/api-reference/endpoints/wallets/create-wallet"},{"openapi":"patch /v1/wallets/settings","title":"Update wallet settings","href":"/api-reference/endpoints/wallets/update-wallet-settings"},{"openapi":"put /v1/wallets/{id}","title":"Update wallet","href":"/api-reference/endpoints/wallets/update-wallet"},{"openapi":"post /v1/wallets/{id}/load","title":"Load wallet","href":"/api-reference/endpoints/wallets/load-wallet"},{"openapi":"post /v1/wallets/{id}/transactions/{transactionId}/revert","title":"Revert wallet load","href":"/api-reference/endpoints/wallets/revert-wallet-load"}]},{"group":"Webhooks","tag":"6","expanded":false,"pages":[{"openapi":"get /v1/webhooks/endpoints/{id}","title":"Get webhook endpoint","href":"/api-reference/endpoints/webhooks/get-webhook-endpoint"},{"openapi":"get /v1/webhooks/endpoints","title":"List webhook endpoints","href":"/api-reference/endpoints/webhooks/list-webhook-endpoints"},{"openapi":"get /v1/webhooks/messages","title":"List webhook messages","href":"/api-reference/endpoints/webhooks/list-webhook-messages"},{"openapi":"post /v1/webhooks/endpoints","title":"Create webhook endpoint","href":"/api-reference/endpoints/webhooks/create-webhook-endpoint"},{"openapi":"put /v1/webhooks/endpoints/{id}","title":"Update webhook endpoint","href":"/api-reference/endpoints/webhooks/update-webhook-endpoint"},{"openapi":"delete /v1/webhooks/endpoints/{id}","title":"Delete webhook endpoint","href":"/api-reference/endpoints/webhooks/delete-webhook-endpoint"}]},{"group":"Workspaces","tag":"2","expanded":false,"pages":[{"openapi":"get /v1/companies","title":"List companies","href":"/api-reference/endpoints/companies/list-companies"},{"openapi":"post /v1/companies","title":"Create company","href":"/api-reference/endpoints/companies/create-company"}]}]}]},{"tab":"Guides","icon":"list-check","pages":[{"title":"Guides","href":"/guides/importing-historical-data"}]},{"tab":"Integrations","icon":"link","pages":[{"title":"Integrations","href":"/integrations/overview"}]},{"tab":"Changelog","icon":"bullhorn","pages":[{"title":"Changelog","href":"/changelog/2026-10"}]}]},"basePath":"","title":"Get billing balance - Hyperline","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","Page-CVJ-f_k1.js","CodeSnippet-D_HwgQO_.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","getApiPlaygroundDisplay-CmCoerhe.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}